Atym CLI Installation

This guide explains how to install the Atym CLI on different operating systems. You can choose between:

• Stable release (recommended for most users)
• Release Candidate (RC) (opt-in, for early testing)

tip

Stable releases are recommended for most users. Only use Release Candidates if you need early access to new features or want to help test upcoming releases.

---

Installing the CLI

The Atym CLI is available through platform-specific package managers for easy installation and updates.

Linux

1. Add the APT repository:

   echo "deb [trusted=yes] http://apt.prod.atym.io stable main" | sudo tee /etc/apt/sources.list.d/atym.list

2. Update package lists:

   sudo apt update

3. Install Atym CLI:

   Stable version (recommended):

   sudo apt install atym

   Release Candidate (RC):

   sudo apt install atym-rc

4. Verify installation:

   atym version

macOS

1. Add the Atym Homebrew tap:

   brew tap atym-io/homebrew-repo

2. Install Atym CLI:

   Stable version (recommended):

   brew install atym

   Release Candidate (RC):

   brew install atym-rc

3. Verify installation:

   atym version

Windows

1. Configure Chocolatey source:

   choco source add -n=atym -s="https://choco.prod.atym.io/chocolatey" --priority=1

2. Install Atym CLI:

   Stable version (recommended):

   choco install atym

   Release Candidate (RC):

   choco install atym --pre

3. Verify installation:

   atym version

---

Upgrading the CLI

To update the Atym CLI to the latest version:

Linux

sudo apt update && sudo apt upgrade atym

macOS

brew upgrade atym

Windows

choco upgrade atym

---

Uninstalling the CLI

If you need to remove the Atym CLI:

Linux

sudo apt remove atym

To also remove the repository configuration:

sudo rm /etc/apt/sources.list.d/atym.list

macOS

brew uninstall atym

To also remove the tap:

brew untap atym-io/homebrew-repo

Windows

choco uninstall atym

To also remove the source:

choco source remove -n=atym

---

Troubleshooting

Command Not Found

If you receive a "command not found" error after installation:

Linux

1. Verify the package is installed:

   dpkg -l | grep atym

2. Check if the binary is in your PATH:

   which atym

3. If needed, restart your terminal session or source your shell configuration.

macOS

1. Verify the package is installed:

   brew list | grep atym

2. Check if the binary is in your PATH:

   which atym

3. If needed, restart your terminal session or run:

   source ~/.zshrc  # or ~/.bash_profile

Windows

1. Verify the package is installed:

   choco list --local-only atym

2. Try restarting your PowerShell or Command Prompt window

3. If the issue persists, check your system PATH environment variable includes the Chocolatey bin directory (usually C:\ProgramData\chocolatey\bin)

Permission Errors

Linux

If you encounter permission errors during installation, ensure you're using sudo:

sudo apt install atym

macOS

Homebrew installations should not require sudo. If you encounter permission issues:

1. Check Homebrew's permissions:

   brew doctor

2. Follow any recommendations provided

Windows

Ensure you're running PowerShell or Command Prompt as Administrator:

1. Right-click on PowerShell/Command Prompt
2. Select "Run as Administrator"
3. Run the installation command again

---

For additional help, contact support@atym.io.