Skip to content
Olympix Documentation

Installation Guide

Welcome to the Olympix installation guide! Get started by installing the CLI and the VSCode extension to access all of Olympix’s powerful features. This guide covers the full process—from downloading the CLI binaries to authenticating your account.

CLI Installation

Section titled “CLI Installation”
Terminal window
curl -o olympix https://olympix-download.s3.amazonaws.com/cli/v0.11.107/osx-arm64/olympix
chmod +x olympix
./olympix login -e user@olympix.ai

Verify your download

Section titled “Verify your download”

Each binary’s SHA-256 is published in the release manifest. After downloading, confirm the file matches:

Terminal window
# macOS / Linux
shasum -a 256 olympix


# Windows (PowerShell)
Get-FileHash olympix.exe -Algorithm SHA256

Expected values for the current release:

PlatformSHA-256
osx-arm64f5c8a80c47aa5e527dd700a666dae375fdd17e57a4b92ab43de9fd6b412b475c
osx-x648e733fec0e6a771f443595e700cedf82d0799782ffe22d9d99796a588635740d
linux-arm64f1c6ba0272bf6350ac1a0b77f911b1fa961d8ef98e1e8d289285fd0170f4f6ac
linux-x64ba8c064c5e5c096dbeb42ed6d4baac7bfac4d42011c848f6935d98396e9a9e17
win-arm64af09fa30f8fa359c6aac0239b1948ba3f58803a388934f7d32712f23a3c91df4
win-x641bad126b9dbe109961256c0b919b4ba31a4ef60bd6a3c50010c5bd78ec4b3279

Authentication

Section titled “Authentication”

After downloading and setting up the CLI, authenticate your account by following these steps:

  1. Run the login command: Execute ./olympix login -e your_email@domain.com in your terminal.

  2. Enter the one-time code: You will receive a one-time code on your email. Enter it in the terminal prompt to complete authentication.

  3. Capture your API token: Once authenticated, your Olympix API token is displayed. Save it securely as it is required for integration with other services, such as GitHub Actions. (This token is also automatically stored in ~/.opix/config.json.)

VSCode Extension

Section titled “VSCode Extension”

Our extension is available in the VSCode Marketplace. Install it to integrate Olympix features directly into your development environment.

Additional Resources

Section titled “Additional Resources”
  • Olympix CLI Documentation: Visit the CLI documentation page for complete command reference and troubleshooting tips.
  • YouTube Tutorial: For a video walkthrough of the setup and usage, watch our YouTube tutorial.

If you encounter any issues or have questions, feel free to reach out to our support team at contact@olympix.ai.