Skip to content

Enhance README with documentation and attribution #17

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ndenny merged 2 commits into from
Jul 10, 2026
Merged

Enhance README with documentation and attribution #17

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
032e1e2
Enhance README with documentation and attribution
ndenny Jul 9, 2026
c5746ee
Add install docs and support info
ndenny Jul 9, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 49 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,46 @@
# APImetrics CLI

A command-line interface for managing API monitors, schedules, SLOs, and more on the [APImetrics](https://apimetrics.io) platform.
A command-line interface for managing API monitors, schedules, SLOs, and more on the [APImetrics](https://apimetrics.io) platform, by [APIContext Inc](https://apicontext.com).

## Documentation

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


## Installation

## Manual installation

The binaries for the APImetrics CLI can be downloaded from the [releases page](https://github.com/APImetrics/APImetrics-cli/releases). 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:

```bash
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):

```powershell
winget install APImetrics.APImetricsCLI
```

## Linux

You can install the APImetrics CLI by downloading the binary from the [releases page](https://github.com/APImetrics/APImetrics-cli/releases).

```bash
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

Expand Down Expand Up @@ -182,3 +222,11 @@ apimetrics logout
```

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

# Issues and Contributing

For support questions, visit [APImetrics Support](https://apicontext.com/support) and open a request.

For reporting bugs or requesting features, please open an issue on the [GitHub repository](https://github.com/APImetrics/APImetrics-cli/issues).

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