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.83/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-arm6464168a83700ff2947febcd6ea6d8aa0c73c8dcc176af1514919766ddafd8eba5
osx-x6452b8171a0a17e5db42ff49bc0f27ff4eec7f9ece158c2d07a90ace49193d0127
linux-arm649bd15757afc4ea6a58b0b4fdfb3baccfdbf71b61ad30d27ee72a182c75ef097d
linux-x64891d7e3c419ea7990af7e0bf732f228c008c9687efa65804a03fc869ef5d51f4
win-arm64f317fa66cdd429dcbc843c5f032c64d39fdec6efd20fcf9291ac8cc9552e23bc
win-x6457c3728f2ed4db03adc5b30054efc40517e51f6626885e9a347d255fbf62bead

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.