🚀 Getting Started

Important

The most popular way to use ACORN is to not install it at all — simply leverage the power and promise of ACORN within a CI job (see this example .gitlab-ci.yml)

Installation

Install with Scoop (Windows only)

• Ensure you have Scoop installed.

• Open your terminal and add the extras bucket to Scoop

  scoop bucket add extras
  

• Run the following command to install ACORN

  scoop install acorn
  

• After installation, you can verify the installation by running:

  acorn help
  

• You can keep ACORN up to date with Scoop by running:

  scoop update acorn
  

Install with Homebrew (Linux and MacOS)

• Add the custom tap:

  brew tap research-enablement/acorn https://github.com/research-enablement/homebrew-acorn
  

• Install ACORN:

  brew install acorn-cli
  

• Verify installation:

  acorn help
  

• Upgrade to the latest version:

  brew update
  brew upgrade acorn-cli
  

Tip

You can use any tap URL for your organization. Keep the formula name as acorn-cli so updates remain consistent.

Install with Cargo

• Ensure you have Rust and Cargo installed. If not, you can install them using rustup.rs.

• Open your terminal and run the following command to install ACORN

  cargo install acorn-cli
  

• After installation, you can verify the installation by running:

  acorn help
  

Run Inside a Container

• Ensure you have Docker¹ installed.

• Pull the latest ACORN image with Docker¹

  docker pull savannah.ornl.gov/research-enablement/acorn/runner
  

• Run ACORN using Docker¹

  docker run --rm savannah.ornl.gov/research-enablement/acorn/runner help
  

Tip

You will probably need to mount a volume to use ACORN with your local files. For example:

docker run --rm -v $(pwd):/data savannah.ornl.gov/research-enablement/acorn/runner:latest check /data/project

Download pre-compiled binary

• Download the latest release from the ACORN GitLab Releases page

  • 🪟 Windows

    • Open a PowerShell terminal, visit the releases page to find the latest version, and run:

      irm -OutFile acorn.exe -Uri https://code.ornl.gov/api/v4/projects/16689/packages/generic/x86_64-pc-windows-gnu/v<version>/acorn.exe
      

    • Test the downloaded executable:

      .\acorn.exe help
      

  • 🐧 Linux

    • Open a terminal, visit the releases page to find the latest version, and run:

      curl -LO https://code.ornl.gov/api/v4/projects/16689/packages/generic/x86_64-unknown-linux-musl/v<version>/acorn
      

    • Make the downloaded file executable:

      chmod +x acorn
      

    • Test the downloaded executable:

      acorn help
      

  • 🍎 MacOS

    🚧 Under construction

Install from source

• Clone the ACORN repository

  git clone https://code.ornl.gov/research-enablement/acorn.git
  cd acorn
  

• Install acorn command

  cargo install --path ./acorn-cli
  

• After installation, you can verify the installation by running:

  acorn help
  

1. These instructions will work with any OCI-compliant container runtime, such as Docker or Podman. ↩ ↩2 ↩3