agex.dev
CLI

Installation

Install the agex CLI and authenticate with GitHub.

Requirements

  • Node.js 18 or later
  • npm, pnpm, or yarn
  • A GitHub account

Install

npm install -g agex

Verify:

agex --version

Authentication

agex uses GitHub's device flow — no passwords, no personal access tokens to create or manage.

agex login

The CLI will:

  1. Print an 8-character code (e.g. ABCD-1234)
  2. Open github.com/login/device in your browser
  3. Ask you to enter the code and authorize agex
  4. Complete automatically once you approve

Your session is stored locally in ~/.config/agex/auth.json and used for all subsequent commands.

Check who you're logged in as

agex whoami

Sign out

agex logout

Local development

To use the CLI against a locally running hub:

AGEX_API_URL=http://localhost:3000 agex push CLAUDE.md

You can also export the variable for a session:

export AGEX_API_URL=http://localhost:3000
agex sync

CLI Overview

The agex CLI connects your local project to the hub — push, pull, and sync agent artifacts from your terminal.

agex.toml

The project manifest — declares your project metadata and all artifact dependencies.

On this page

RequirementsInstallAuthenticationCheck who you're logged in asSign outLocal development