Skip to content

Add link to docs for API keys #21

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
parath merged 1 commit into from
Jan 11, 2024
Merged

Add link to docs for API keys #21

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 2 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ This is the official command line interface for the Cycleops API.

## Requirements

To run the Cycleops CLI either Python 3.1 or newer, or Docker is required.
To run the Cycleops CLI either Python 3.11 or newer, or Docker is required.

## Installation

Expand All @@ -29,9 +29,7 @@ docker run -e CYCLEOPS_API_KEY=your-api-key ghcr.io/stackmasters/cycleops --help

### Authentication

To authenticate with the Cycleops CLI, you need to provide an API key.

You can find your API keys in the Cycleops UI, under the `Team` category. Alternatively you can create a new API key by visiting `Team > Users > Add New > API key`.
To authenticate with the Cycleops CLI, you need to provide an API key. Documentation on how to create an API key is available at https://cycleops.io/docs/api-keys/create-a-new-api-key.

#### Environment variable

Expand Down