Skip to main content

CLI for Expedait project management — download specs, post comments

Project description

Expedait CLI

License Python 3.11+

Command-line interface for Expedait — download project specs and post comments from AI coding agents.

Quickstart

# Install with uv (recommended)
uv pip install expedait-cli

# Or install from source
git clone https://github.com/Expedait/expedait-cli.git
cd expedait-cli
uv sync

# Login to your Expedait instance
expedait auth login

# List your projects
expedait projects list

# Download all specs for a project
expedait projects download 1 --output-dir ./specs

Installation

From PyPI

pip install expedait-cli

From source

git clone https://github.com/Expedait/expedait-cli.git
cd expedait-cli
uv sync

This creates a virtual environment with the expedait command available.

Requirements: Python 3.11+

Authentication

Interactive login

expedait auth login

Prompts for login method (SSO or email/password). Stores credentials in ~/.expedait/config.json.

Environment variables (CI / agents)

export EXPEDAIT_TOKEN="your-jwt-token"
export EXPEDAIT_API_URL="https://your-instance.expedait.com"
export EXPEDAIT_TENANT_ID=1

Token resolution order: EXPEDAIT_TOKEN env var > ~/.expedait/config.json > error.

Commands

Auth

expedait auth login       # Interactive login
expedait auth status      # Show current user and tenant
expedait auth logout      # Clear stored credentials

Projects

expedait projects list                              # List all projects
expedait projects get PROJECT_ID                    # Get project details
expedait projects download PROJECT_ID               # Download all pages as ZIP
expedait projects download PROJECT_ID --output-dir ./specs  # Extract to directory

Pages

expedait pages list --project-id PROJECT_ID         # List pages in a project
expedait pages get PAGE_ID                          # Print page markdown content
expedait pages full PAGE_ID                         # Full context (content + comments + deps)
expedait pages download PAGE_ID --output-dir ./out  # Download page as ZIP

Comments

expedait comments list PAGE_ID                      # List comments on a page
expedait comments create PAGE_ID \                  # Create a comment
  --text "Comment content" \
  --selected-text "text from page" \
  --start-offset 100 \
  --end-offset 120 \
  --source-page-id 5                                # Optional: agent's source page
expedait comments resolve PAGE_ID COMMENT_ID        # Mark as resolved
expedait comments delete PAGE_ID COMMENT_ID         # Delete a comment

Global Options

expedait --api-url https://host:8000 ...    # Override API URL
expedait --tenant-id 2 ...                  # Override tenant
expedait --format json ...                  # Force JSON output
expedait --format text ...                  # Force human-readable output
expedait --version                          # Show version

Output format defaults to text when connected to a terminal, json when piped.

Agent Skills

For step-by-step guides on using the CLI from AI coding agents, see expedait-skills.

Development

git clone https://github.com/Expedait/expedait-cli.git
cd expedait-cli
uv sync --group dev
uv run python -m pytest

Contributing

Contributions are welcome! Please open an issue or submit a pull request.

License

This project is licensed under the Apache License 2.0.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

expedait_cli-0.2.1.tar.gz (21.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

expedait_cli-0.2.1-py3-none-any.whl (16.1 kB view details)

Uploaded Python 3

File details

Details for the file expedait_cli-0.2.1.tar.gz.

File metadata

  • Download URL: expedait_cli-0.2.1.tar.gz
  • Upload date:
  • Size: 21.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for expedait_cli-0.2.1.tar.gz
Algorithm Hash digest
SHA256 a4d6007a1cef780d16d6ef68f80d8b8509dcb82111cc945cd8501dfac5318bdd
MD5 3e703bdc2ddab52d087b2008d7fd55b3
BLAKE2b-256 83cf9cb5f75db5822356ac379e2df3c5078a8f480c9bbb017b05527c52dc491b

See more details on using hashes here.

Provenance

The following attestation bundles were made for expedait_cli-0.2.1.tar.gz:

Publisher: publish.yml on Expedait/expedait-cli

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file expedait_cli-0.2.1-py3-none-any.whl.

File metadata

  • Download URL: expedait_cli-0.2.1-py3-none-any.whl
  • Upload date:
  • Size: 16.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for expedait_cli-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 be063efcb46951c4a78472dc0544ff1d892fd932c3331336b9a191ba49beac1a
MD5 cf68dbc5a6a7e7aa4f8c4cdc1bf90761
BLAKE2b-256 e8ee7e30b3e1bba14c7a6b8c0e6f839a9e1eeac62821197c1b82f4a0ad92728d

See more details on using hashes here.

Provenance

The following attestation bundles were made for expedait_cli-0.2.1-py3-none-any.whl:

Publisher: publish.yml on Expedait/expedait-cli

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page