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.100/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-arm64fcdb437db00e901ce2fb136410d2cc17d912c168d1cc29124afb00aa005cc300
osx-x646e63360e3db12f9c170df0228ccf2033920f6785ad74aef5861e038cd965354a
linux-arm643d433b8c19ed61f913822f14b2ea9bd25d3d3c025523e2e7ff80fbf15720c4e7
linux-x640857a8709c209f99d4987114722815f2823ec31115c6a23822f481e37d9a84f2
win-arm64d67547fbf50b2462c303fee867764835846785397174bf3106bd68f377a67d5e
win-x64df648a73278e6f37b43b56b1ba6933b4eeefa5bc9877acd7421ee84eaef7c554

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.