APImetrics CLI

A command-line interface for managing API monitors, schedules, SLOs, and more on the APImetrics platform, by APIContext Inc.

Documentation

For more information, please visit our main documentation site, available at https://docs.apicontext.com/cli.

Installation

Manual installation

The binaries for the APImetrics CLI can be downloaded from the releases page. Choose the appropriate version for your operating system and put the executable in your path for easy access from the command line.

MacOS

You can install the APImetrics CLI using Homebrew:

brew install apicontext/tap/apimetrics-cli

Windows - Coming soon!

Note: Coming soon, not available yet

You can install the APImetrics CLI using the Windows Package Manager (winget):

winget install APImetrics.APImetricsCLI

Linux

You can install the APImetrics CLI by downloading the binary from the releases page.

curl -LO https://github.com/APImetrics/APImetrics-cli/releases/latest/download/apimetrics-[version]-linux-amd64.tar.gz
tar -xzf apimetrics-[version]-linux-amd64.tar.gz
sudo mv apimetrics /usr/local/bin/apimetrics

Note: [version] should be replaced with the specific version you want to download, e.g., 0.0.1.

Getting Started

1. Log in

apimetrics login

This opens your browser for OAuth2 authentication. Your credentials are cached locally and refreshed automatically.

2. Select a project

All commands require an active project. Run the following to choose one:

apimetrics project select

To confirm which project is currently active:

apimetrics project show

3. Run your first command

# List all API calls in the current project
apimetrics list-calls

# List all schedules
apimetrics list-schedules

To see all supported commands, run

apimetrics --help

Passing Input

All create and update commands read a JSON body from stdin using a heredoc. There is no --body, --data, or -d flag.

apimetrics create-call <<'EOF'
{
  "meta": {
    "name": "My API Check"
  },
  "request": {
    "method": "GET",
    "url": "https://api.example.com/health"
  }
}
EOF

You can also use CLI Shorthand as a concise alternative to JSON:

apimetrics create-call meta.name: "My API Check", request.method: GET, request.url: https://api.example.com/health

Or pipe from a file:

apimetrics create-call < my-call.json

Output Formats

Use -o / --rsh-output-format to control output:

Format	Description
auto (default)	Pretty in terminal, JSON when piped
json	Standard JSON
yaml	YAML
table	Tabular layout (best for lists)
readable	Colorized human-readable format
gron	Grep-friendly flattened format

# Table output
apimetrics list-calls -o table

# Raw JSON for scripting
apimetrics list-calls -o json

# Filter results with a query expression
apimetrics list-calls -f body[0].meta.name

When output is redirected to a pipe or file, color is disabled and only the body is printed as JSON automatically.

Global Flags

These flags work with every command:

Flag	Short	Description
--rsh-output-format	-o	Output format (auto/json/yaml/table/readable/gron)
--rsh-filter	-f	Filter/project response using a query expression
--rsh-raw	-r	Raw output (strips quotes from strings)
--rsh-verbose	-v	Verbose logging
--rsh-header	-H	Add a request header (repeatable)
--rsh-query	-q	Add a query parameter (repeatable)
--rsh-profile	-p	Use a named auth profile
--rsh-server	-s	Override the API server base URL
--rsh-no-cache		Disable HTTP caching
--rsh-no-paginate		Disable automatic pagination
--rsh-retry		Retry count (default 2)
--rsh-timeout	-t	HTTP request timeout
--rsh-insecure		Disable TLS verification

Shell Completion

Enable tab completion for your shell:

# Bash
apimetrics completion bash >> ~/.bash_profile

# Zsh
apimetrics completion zsh >> ~/.zshrc

# Fish
apimetrics completion fish > ~/.config/fish/completions/apimetrics.fish

# PowerShell
apimetrics completion powershell >> $PROFILE

Once enabled, press tab to explore available commands and their arguments.

AI Agent Integration

The CLI includes built-in skills for AI coding agents (e.g. Claude Code). These skills teach agents how to create and configure monitors using the CLI.

Install skills into Claude Code:

apimetrics skills install --claude-code

Print all skills to stdout (for any agent or model that can read context):

apimetrics onboard

Available skills:

• setup-api-monitor — Create an API (HTTP) monitor, attach a schedule, and verify it
• setup-browser-monitor — Create a browser monitor, attach a schedule, and verify it
• setup-mcp-monitor — Create an MCP protocol monitor with session steps

Configuration

Configuration and cached tokens are stored in platform-specific locations:

OS	Config	Cache
macOS	~/Library/Application Support/apimetrics/	~/Library/Caches/apimetrics/
Linux	~/.config/apimetrics/	~/.cache/apimetrics/
Windows	%AppData%\apimetrics\	%LocalAppData%\apimetrics\

Override these locations with environment variables:

export APIMETRICS_CONFIG_DIR=/path/to/config
export APIMETRICS_CACHE_DIR=/path/to/cache

Logout

apimetrics logout

This removes cached tokens. Run apimetrics login again to re-authenticate.

Issues and Contributing

For support questions, visit APImetrics Support and open a request.

For reporting bugs or requesting features, please open an issue on the GitHub repository.

We welcome contributions! Feel free to fork the repository, make changes, and submit pull requests.