Skip to content

Running Amico

Prerequisites

Rust

Amico is built with Rust, so you need to have Rust installed on your system. You can install Rust via rustup:

Terminal
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

Follow the on-screen instructions to complete the installation. After installation, you can verify your Rust installation with:

Terminal
rustc --version

This will display the installed Rust version.

System Requirements

Officially Supported Operating Systems

  1. Ubuntu amd64 / arm64
  2. Raspbian arm64
  3. Arch Linux amd64

Future Supported Operating Systems

  1. Android arm64 (Near future)
  2. Debian amd64 / arm64 (Near future)
  3. iOS arm64
  4. Windows amd64
  5. macOS amd64 / arm64

Platforms / Architectures Planned for Support

  1. WASM (Near future)
  2. RISC-V

Required Dependencies

Depending on your operating system, you may need to install additional dependencies:

Debian/Ubuntu

Terminal
sudo apt update
sudo apt install pkg-config libasound2-dev libmp3lame-dev

For the updated list, see the pkglist for deb

Arch Linux

Terminal
sudo pacman -S base-devel pkgconf alsa-lib lame

For the updated list, see the pkglist for pacman

Getting Started

Cloning the Repository

First, clone the Amico repository from GitHub:

Terminal
git clone https://github.com/AIMOverse/amico
cd amico

Building Amico

Once you have cloned the repository, you can build Amico using Cargo, Rust's package manager and build system:

Terminal
cargo build -p amico

This command compiles the Amico package and its dependencies. The compiled binary will be available in the target/debug directory.

Running Amico

To build and run Amico in a single step, use:

Terminal
cargo run -p amico

Configuration

Setting Up Environment Variables

Amico requires certain environment variables to function properly. The most important one is the OPENAI_API_KEY for AI capabilities:

Terminal
export OPENAI_API_KEY="your-api-key-here"

Note: The current runtime implementation uses OpenAI as the default LLM service provider, requiring you to set the "OPENAI_API_KEY" environment variable. You can modify the codebase to integrate with alternative LLM providers if needed.

Troubleshooting

Common Issues

  • Missing API Key: If you see an error about a missing API key, ensure you've set the OPENAI_API_KEY environment variable.
  • Build Failures: Make sure you have all the required dependencies installed for your operating system.

Next Steps

Now that you have Amico running, you might want to explore: