Installation

To begin using Accio, you first need to install the Accio CLI. The Accio CLI is a command-line tool that assists in initializing a Accio project, building your own Accio MDL.

Install From Binary

We provide pre-built binaries for Linux, macOS, and Windows. The binary includes all dependencies, so you don't need to install any additional dependencies.

MacOS

Let's go ahead and grab the newest version of Accio CLI from this link: accio-cli. Once the download is complete, you'll need to extract the file and move it to /usr/local/bin:

tar zxvf accio.osx.tar.gz
mv accio /usr/local/bin

Linux

Let's go ahead and grab the newest version of Accio CLI from this link: accio-cli. Once the download is complete, you'll need to extract the file and move it to /usr/local/bin:

tar zxvf accio.linux.tar.gz
mv accio /usr/local/bin

Windows

1. Downloading the File: Download the latest version of Accio CLI from: accio.exe.
2. Extracting the File: Once the download is complete, locate the zip folder in your 'Downloads' directory. Extract the zip folder.
3. Moving the accio.exe File: Inside the extracted folder, find the accio.exe file. Cut or copy this file and navigate to the location where you want to store it. This could be a specific directory or your desktop for easy access.

Install from NPM (not yet)

Preparing the installation

Please ensure the following environment is set up before starting the manual installation:

• Verify Node.js version 16 or higher with node --version. If not installed or lower version, visit https://nodejs.org to install.
• Your preferred Node.js package manager: NPM or Yarn

NPM Install

npm i -g @accio/cli

Manual Install

Steps

1. Clone the repository:

   git clone https://github.com/Canner/accio-cli.git

2. Change to the project directory:

   cd accio-cli

3. Install dependencies:

   yarn install

4. Choose the appropriate installation method based on your preference:

   a. Docker Build:

   docker build --output=outdir --target binaries .

   b. Host Environment Build:

   yarn nx run cli:pkg:development

5. Choose the appropriate executable for your platform. For example, if you are using Linux, execute the following command to move the executable to /usr/bin/accio:

   mv ./outdir/cli-linux /usr/bin/accio

Remember to adjust the instructions based on your platform (e.g., macOS, Windows) and specify the desired location for the executable file.

Next Step

After installing Accio CLI, you can start initializing your project. Head to Quick Start to learn how to create your first Accio MDL.