Skip to main content

Token — a colorful CLI coding agent with file tools, shell execution, and swappable LLM providers

Project description

Token

PyPI version Python

A colorful CLI coding agent built in Python. It reads and writes files, searches code, runs shell commands, and chats with you via OpenAI — all from your terminal with a Rich-powered UI.

Install

Recommended — isolated CLI install with pipx:

pipx install excergic-token

Or with pip:

pip install excergic-token

Or with uv:

uv tool install excergic-token

Requires Python 3.11+.

Quick start

pipx install excergic-token
token

On first run, Token asks for your OpenAI API key and model, saves them to ~/.config/token/, then opens the chat. Workspace defaults to your current directory.

# Optional: override via environment
export OPENAI_API_KEY=sk-...
export OPENAI_MODEL=gpt-4.1

token

Usage

# Start the agent (default — uses current directory as workspace)
token

# Optional flags
token --model gpt-4.1-mini --workspace /path/to/project

# Version
token version

Features

  • File tools — read, write, create, list directories, regex search
  • Shell execution — run commands in your workspace (with permission)
  • Human-in-the-loop — destructive actions require explicit approval (y / a / n)
  • Workspace sandbox — all paths confined to a configurable root
  • Swappable LLM — provider abstraction with OpenAI as the default
  • Colorful UI — Rich panels, markdown, syntax highlighting, spinners

Slash commands

Command Description
/help Show help
/clear Clear conversation history
/setup Update API key and model
/exit Quit

Permission prompts

When the agent wants to write a file or run a shell command, you'll see a preview and be asked:

  • y — allow once
  • a — allow all for this session
  • n — deny

Configuration

Environment variables (via .env or shell):

Variable Default Description
OPENAI_API_KEY Your OpenAI API key
OPENAI_MODEL gpt-4o Model to use
LLM_PROVIDER openai LLM provider (extensible)
WORKSPACE_ROOT . Sandbox workspace root

Development

git clone https://github.com/Excergic/Token.git
cd Token
uv sync
cp .env.example .env   # add your API key
uv run token chat --workspace .

Publishing (maintainers)

Releases are published to PyPI as excergic-token via GitHub Actions when a GitHub Release is published.

  1. Configure PyPI Trusted Publishing for excergic-token → GitHub Excergic/Token
  2. Create a GitHub environment named pypi in repo settings
  3. Tag and release:
git tag v0.1.0
git push origin v0.1.0
# Create a GitHub Release from the tag — CI publishes automatically

Manual publish:

uv build
UV_PUBLISH_TOKEN=pypi-... uv publish

License

MIT

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

excergic_token-0.1.2.tar.gz (21.6 kB view details)

Uploaded Source

Built Distribution

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

excergic_token-0.1.2-py3-none-any.whl (35.4 kB view details)

Uploaded Python 3

File details

Details for the file excergic_token-0.1.2.tar.gz.

File metadata

  • Download URL: excergic_token-0.1.2.tar.gz
  • Upload date:
  • Size: 21.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for excergic_token-0.1.2.tar.gz
Algorithm Hash digest
SHA256 68f199a5f8c64e808ad58782a1e51e668223470b3fbd98fc0cc290c619d4384c
MD5 282be84ceaf8a376f738dcb3fa1131e5
BLAKE2b-256 c4a5206852db7628e5e685f58cb4b1ce0651bb3c3eeaefbf1442f818ba82dce4

See more details on using hashes here.

Provenance

The following attestation bundles were made for excergic_token-0.1.2.tar.gz:

Publisher: publish.yml on Excergic/Token

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

File details

Details for the file excergic_token-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: excergic_token-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 35.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for excergic_token-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 520267191cda94c84380fec546c16390b69fc17ef1d36cebea23e1704ed47aa7
MD5 77d8cb328387819baf8c375a08442eda
BLAKE2b-256 5371a2df664d99c5d09faca8d01d739196bd7794e527271cd2a9045e0399fcf1

See more details on using hashes here.

Provenance

The following attestation bundles were made for excergic_token-0.1.2-py3-none-any.whl:

Publisher: publish.yml on Excergic/Token

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