Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
alexellis committed May 18, 2023
1 parent e900cd1 commit 40b8965
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# actuated-cli

The actuated-cli requires an access token for GitHub and is designed to be used by a user with access to the actuated dashboard.

Most of the operations on the actuated dashboard are available as CLI commands.

## Installation

Download the latest release from the [releases page](https://github.com/self-actuated/actuated-cli/releases).
Expand All @@ -12,6 +16,12 @@ export ACTUATED_URL=https://example.com

Or, run this command in a shell before executing any of the CLI commands.

## Obtain a token from GitHub for your own account

Obtain a Personal Access Token (PAT) from [https://github.com/settings/tokens](https://github.com/settings/tokens)

Save it as for example: `~/pat.txt`

## View queued jobs

```bash
Expand Down

0 comments on commit 40b8965

Please sign in to comment.