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.138/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-arm64c6ca0ca3a02c5cb6f3eaf1b5209a91cbbe8010fe9567010197c5fc5f53654fb4
osx-x642e5d147f8ec39d5d23ec535ea21e11c5dee04df183ce37687caf993bcb32464c
linux-arm645a9d473561913f6cd191d41897818f474a905e5a3b51a4de0a95d5701055e228
linux-x645dbba8bc4063f8a4456ef3e89ae519aefa8d5f6397daf00005910cd68fcfaa81
win-arm64b4db882b17adda5604bc3c2bbf99df5951c9a8b18e6ed49acb2fa71ee5acda99
win-x64a01c64c3d2705eef35c0bee54a9ff06eb4a41a990cd70add34d24a17680e17c8

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.