cli AGENTS.md

A development guide for the Axiom command-line application. It describes build and test commands, the program entry point, and the factory that shares configuration and API clients across commands.

In plain words
What is it for?
It helps build, test, lint, format, install, and document the Go command-line tool, as well as understand how its commands and authenticated API clients are connected.
Why use it?
It gives coding agents the project's expected workflow and structure, making changes less likely to break builds, tests, or command behavior.

Instructions file for CodexOpenCode

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add instructions/axiomhq/cli/agents-md
Clone the repo
git clone --depth 1 https://github.com/axiomhq/cli

Made for: Codex, OpenCode.

Per session 1,035 This file is loaded in full into every session.
When invoked 1,035 The same file — it is already loaded in full.
Security scan A 0 findings. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.01035 $0.01035
Opus 5 $0.00517 $0.00517
Sonnet 5 $0.00207 $0.00207
Haiku 4.5 $0.00103 $0.00103

Measured 2d ago against content hash 77f720daae70, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

cli AGENTS.md scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 2d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

AGENTS.md · 119 lines

How it starts

The opening of the file, as written. The whole thing — 119 lines — stays where its author put it; the contents beside it link to each section on GitHub.

AGENTS.md

This file provides guidance to AI coding assistants (Claude Code, Cursor, GitHub Copilot, etc.) when working with code in this repository.

Build & Development Commands

make dep          # Install and verify dependencies
make build        # Build binaries (uses goreleaser snapshot)
make test         # Run all tests with race detection
make lint         # Run golangci-lint
make fmt          # Format code with golangci-lint fmt
make install      # Install binary to $GOPATH/bin
make man          # Generate man pages
make completions  # Generate shell completion scripts
make all          # Run dep, generate, fmt, lint, test, build, man

Run a single test:

go test -race -run TestName ./path/to/package

Verbose test output:

make test VERBOSE=1

Architecture

Entry Point

cmd/axiom/main.go - Sets up signal handling, creates the Factory, configures survey prompts, and executes the root command.

Factory Pattern

internal/cmdutil/factory.go - The Factory struct bundles shared resources (Config, IO) and provides methods like Client() to create authenticated Axiom API clients. It flows through the entire command hierarchy.

Command Structure

Commands live in internal/cmd/<command>/ with a consistent pattern:

  • <command>.go - Main command with NewCmd(f *cmdutil.Factory) constructor
  • <command>_<subcommand>.go - Subcommands

Commands are grouped:

  • Core: ingest, query, stream - Data operations
  • Management: annotation, config, dataset - Resource management
  • Additional: auth, completion, version, web

Configuration

internal/config/config.go - TOML-based config (~/.axiom.toml) with environment variable overrides via AXIOM_ prefix (token, org_id, url, deployment). Supports multiple named deployments.

Client

internal/client/client.go - Wraps axiom-go SDK with CLI-specific HTTP transport settings. Uses github.com/axiomhq/axiom-go/axiom for all API operations.

Read the full file on GitHub · 119 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 2d ago First seen · 119 lines · 1,035 tokens per session scan A 77f720daae70

Subscribe to this mod's changes

cli AGENTS.md is an instructions file published in the GitHub repository axiomhq/cli (59 stars, last pushed 6d ago), licensed MIT. It adds 1,035 tokens to every session, about $0.0052 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.