august-cli

August CLI

The August API provides programmatic access to legal document intelligence and research workflows.

Non-Obvious Insight: August isn't just a document search tool. It's a legal knowledge graph. Every file, folder, and query is a signal about how a legal team structures, retrieves, and generates work product — enabling compound insights no single API wrapper could produce.

Learn more at August.

Built by AIF Of Counsel.

Install

Go

go install github.com/AIF-Of-Counsel/august-cli/cmd/august-pp-cli@latest

Or clone and build from source:

git clone https://github.com/AIF-Of-Counsel/august-cli.git
cd august-cli
go build ./cmd/august-pp-cli

Pre-built binary

Download a pre-built binary for your platform from the latest release.

On macOS, clear the Gatekeeper quarantine:

xattr -d com.apple.quarantine <binary>

On Unix, mark it executable:

chmod +x <binary>

Quick Start

1. Set Up Credentials

Get your API key from the August dashboard, then store it:

august auth set-token YOUR_TOKEN_HERE

Or set it via environment variable (recommended for agents):

export AUGUST_API_KEY="ak_..."

2. Verify Setup

august doctor

3. Try Your First Command

august projects

Commands

projects

• august projects list — List all accessible projects
• august projects members list-project <project_id> — List members of a project

search

• august global-search --q "term" — Global full-text search
• august project-search <project_id> --q "term" — Search within a project

folders

• august folders contents get-folder <folder_id> — Get folder contents
• august folders tree get-folder <folder_id> — Get full folder tree

files

• august files --doc-ids <id1,id2> [--use-pdf] [--ttl 3600] — Get presigned download URLs

queries (Genius Mode)

• august queries --query "legal question" [--project-id <id>] [--folder-ids <ids>] [--file-ids <ids>] [--mode deep_research|cowork_agent|auto] — Submit a query (async; defaults to deep_research)
• august queries status get-query <query_id> — Poll query status
• august queries result get-query <query_id> — Get completed result
• august queries files get-query <query_id> — Get generated files (work products)

Auth

The CLI authenticates with a Bearer token. Set via:

1. Environment variable (recommended): export AUGUST_API_KEY=ak_...
2. Config file: august auth set-token <token> → stored in ~/.config/august-pp-cli/config.toml
3. agentcookie: If you use agentcookie to sync secrets across machines, credentials are auto-adopted

Output Formats

# Human-readable table (default in terminal)
august projects

# JSON for scripting and agents
august projects --json

# Filter to specific fields
august projects --json --select id,name

# Dry run — preview the request without sending
august projects --dry-run

# Agent mode — JSON + compact in one flag
august projects --agent

Agent Usage

This CLI is designed for AI agent consumption:

• Non-interactive — never prompts, every input is a flag
• Pipeable — --json output to stdout, errors to stderr
• Filterable — --select id,name returns only needed fields
• Previewable — --dry-run shows the request without sending
• Offline-friendly — sync/search can use local SQLite store
• Typed exit codes — 0 success, 2 usage, 3 not found, 4 auth, 5 API error, 7 rate limited

Health Check

august doctor

Configuration

Config file: ~/.config/august-pp-cli/config.toml

Environment variables:

Troubleshooting

Authentication errors (exit code 4)

• Run august doctor to check credentials
• Verify the environment variable: echo $AUGUST_API_KEY

Not found errors (exit code 3)

• Check the resource ID is correct
• Run the list or contents command to see available items

Generated by CLI Printing Press. Built with ❤️ by AIF Of Counsel.