Amplitude CLI Website

The website of the Amplitude CLI, the official command-line tool to manage your Amplitude projects. It presents the CLI, documents the commands you can run today, and hosts the scripts that install it.

Visit the website | CLI repository | Documentation

What's In The Site

• A single page that walks through the CLI workflow: create a project, author assets, validate and build.
• A browsable reference of the available commands, grouped by topic.
• One-command install instructions for Linux, macOS and Windows.
• The install scripts themselves, served at /install.sh and /install.ps1.
• Four languages: English, French, Japanese and Chinese, each at its own URL (/, /fr, /ja, /zh).
• A custom 404 page and a sticky header with a language dropdown.

Install Scripts

The CLI is installed with a single command:

# Linux and macOS
curl -fsSL https://cli.amplitudeaudiosdk.com/install.sh | bash

# Windows (PowerShell)
powershell -NoProfile -Command "iex (irm 'https://cli.amplitudeaudiosdk.com/install.ps1')"

Both scripts download the release archive from the CLI's GitHub releases, verify its SHA-256 checksum, and install am to ~/.amplitude/bin along with the shell completions. They accept --beta / --nightly (-Beta / -Nightly on Windows) and the AM_VERSION, AM_INSTALL_DIR and AM_REPO environment variables. See the header of each script for the full list.

The scripts depend on the asset names published by the CLI's release.yml and nightly.yml workflows. If those change, update the scripts in the same change.

Tech Stack

• SvelteKit with Svelte 5 (runes mode)
• Tailwind CSS v4, with the design tokens defined in src/routes/layout.css
• Paraglide for translations
• adapter-static, deployed to GitHub Pages
• Bun as the package manager

Getting Started

You need Bun installed.

bun install
bun run dev

The site is then available at http://localhost:5173.

Command	Does
bun run dev	Start the development server
bun run build	Build the static site into build/
bun run preview	Preview the production build
bun run check	Type-check the project with svelte-check

bun run check currently reports one error coming from the generated src/lib/paraglide/ folder. It is not caused by the site's own code.

Project Structure

messages/              Translations, one JSON file per language
src/
  lib/
    components/        Header, footer, language dropdown and shared pieces
      sections/        One component per section of the home page
    data/              Site links, install commands and the command reference
  routes/              The home page, the layout and the error page
static/
  install.sh           Install script for Linux and macOS
  install.ps1          Install script for Windows
  images/              Logos and icons
  CNAME                Custom domain for GitHub Pages
.github/workflows/     GitHub Pages deployment

Translations

All visible text lives in messages/{en,fr,ja,zh}.json, and components read it with m.some_key(). Messages mark inline code with backticks, which the Rich component renders as <code>. Commands, flags and brand names are not translated.

The locale is taken from the URL (/fr, /ja, /zh), never from a cookie, so every language is prerendered as its own static page.

Deployment

Every push to main builds the site and publishes it to GitHub Pages through .github/workflows/deploy.yml. In the repository settings, set Pages > Source to GitHub Actions. The custom domain is configured by static/CNAME.

Contributing

Contributions are welcome. Please read the contributing guide first, and feel free to open an issue if something looks wrong or could be better.

License

This project is licensed under the Apache License 2.0.