Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
kajogo777 committed Jan 4, 2025
1 parent a8f7e34 commit 9120fa0
Showing 1 changed file with 87 additions and 1 deletion.
88 changes: 87 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,87 @@
# Stakpak cli
# Stakpak CLI

> **Warning**
> This CLI tool is under heavy development and breaking changes should be expected. Use with caution.
A CLI for the Stakpak API. Manage all your DevOps flows and configurations in one place, with AI-agents helping you out.

## Installation

### Homebrew (macOS & Linux)

```bash
brew tap stakpak/homebrew-stakpak
brew install stakpak
```

### Binary Release

Download the latest binary for your platform from our [GitHub Releases](https://github.com/stakpak/stakpak/releases).

#### Linux (x86_64)

```bash
curl -L "https://github.com/stakpak/stakpak/releases/latest/download/stakpak-linux-x86_64.tar.gz" | tar xz
sudo mv stakpak /usr/local/bin/
```

#### macOS (Intel)

```bash
curl -L "https://github.com/stakpak/stakpak/releases/latest/download/stakpak-darwin-x86_64.tar.gz" | tar xz
sudo mv stakpak /usr/local/bin/
```

#### macOS (Apple Silicon)

```bash
curl -L "https://github.com/stakpak/stakpak/releases/latest/download/stakpak-darwin-aarch64.tar.gz" | tar xz
sudo mv stakpak /usr/local/bin/
```

### Docker

```bash
docker pull ghcr.io/stakpak/stakpak:latest
```

To run the CLI using Docker:

```bash
docker run ghcr.io/stakpak/stakpak:latest <command>
```

## Usage

### Authentication

You can also use the env var `STAKPAK_API_KEY`.

Login with your API key (alternative to env var)

```bash
stakpak login --api-key <YOUR_API_KEY>
```

View current account

```bash
stakpak account
```

### Flow management

- List flows
- Get flow versions
- Clone configurations from a flow version
- Push configurations to a new flow
- Push configurations to an existing flow
- Perform LLM-powered queries on your configurations

### Agents

- List agent types
- List agent sessions and checkpoints
- Get agent checkpoint state
- Run agent
- Run agent form a specific checkpoint

0 comments on commit 9120fa0

Please sign in to comment.