Stakpak

https://stakpak.gitbook.io/docs
Admin
Stakpak is an open-source DevOps agent written in Rust that helps secure, deploy, and maintain...
Tokens:16,763
Snippets:220
Trust Score:10
Update:8 months ago
Show doc for...
Tokens:
Raw
### Configure Stakpak in Zed Settings (Manual Install)

Source: https://stakpak.gitbook.io/docs/tutorial/install-stakpak-in-zed-ide

This JSON snippet is added to the Zed IDE settings file to manually configure the Stakpak agent. It specifies the command to run, arguments, and environment variables for the agent server.

```json
",
"agent_servers": {
    "Stakpak": {
      "command": "stakpak",
      "args": ["acp"],
      "env": {}
    }
  }
```

--------------------------------

### Manually Install Stakpak on macOS (ARM64)

Source: https://stakpak.gitbook.io/docs/tutorial/install-stakpak-in-zed-ide

This script downloads, extracts, and installs the Stakpak agent binary for macOS ARM64 systems. It then verifies the installation by checking the version.

```bash
# macOS (ARM64)
curl -LO https://github.com/stakpak/agent/releases/download/v0.2.66/stakpak-darwin-aarch64.tar.gz
tar -xzf stakpak-darwin-aarch64.tar.gz
sudo mv stakpak /usr/local/bin/

# Verify installation
stakpak --version
```

--------------------------------

### Verify Stakpak API Key (Troubleshooting)

Source: https://stakpak.gitbook.io/docs/tutorial/install-stakpak-in-zed-ide

This command-line snippet is used to check if the STAKPAK_API_KEY environment variable is set correctly. This is a common troubleshooting step for agent connection issues.

```bash
echo $STAKPAK_API_KEY
```

--------------------------------

### Stakpak Configuration Sample (TOML)

Source: https://stakpak.gitbook.io/docs/get-started/configure-stakpak

A sample TOML configuration file for Stakpak, demonstrating profile-based settings. It includes configurations for default, production, and development environments, specifying API endpoints, allowed tools, auto-approval lists, and rulebook inclusion/exclusion criteria.

```toml
# Stakpak Configuration File

# Profile-based configuration allows different settings for different environments
[profiles]

# Special 'all' profile - settings that apply to ALL profiles as defaults
# Individual profiles can override these settings
[profiles.all]
api_endpoint = "https://apiv2.stakpak.dev"
# Common tools that should be available across all profiles
allowed_tools = ["view", "search_docs", "read_rulebook", "local_code_search"]
# Conservative auto-approve list that works for all environments
auto_approve = ["view", "search_docs", "read_rulebook"]

[profiles.all.rulebooks]
# Common rulebook patterns for all profiles
include = ["stakpak://yourdomain.com/common/**"]
exclude = ["stakpak://yourdomain.com/archive/**"]
include_tags = ["common", "shared"]
exclude_tags = ["archived", "obsolete"]

# Default profile - used when no specific profile is selected
# Inherits from 'all' profile and can override specific settings
[profiles.default]
api_key = "your_api_key_here"

# Extends the 'all' profile's allowed_tools with additional development tools
allowed_tools = ["view", "search_docs", "read_rulebook", "local_code_search", "create", "str_replace", "run_command"]

# Inherits auto_approve from 'all' profile (view, search_docs, read_rulebook)
# No need to redefine unless you want to override

# Rulebook filtering configuration
[profiles.default.rulebooks]
# URI patterns to include (supports glob patterns like * and **)
include = ["stakpak://yourdomain.com/*", "stakpak://**/*.md"]

# URI patterns to exclude (supports glob patterns)
exclude = ["stakpak://restricted.domain.com/**"]

# Tags to include - only rulebooks with these tags will be loaded
include_tags = ["terraform", "kubernetes", "security"]

# Tags to exclude - rulebooks with these tags will be filtered out
exclude_tags = ["deprecated", "experimental"]

# Production profile - stricter settings for production environments
# Inherits from 'all' profile but restricts tools for safety
[profiles.production]
api_key = "prod_api_key_here"

# Restricts allowed_tools to only read-only operations (overrides 'all' profile)
allowed_tools = ["view", "search_docs", "read_rulebook"]

# Uses the same conservative auto_approve list from 'all' profile
# No need to redefine since 'all' profile already has safe defaults

[profiles.production.rulebooks]
# Only include production-ready rulebooks
include = ["stakpak://yourdomain.com/prod/**"]
exclude = ["stakpak://yourdomain.com/dev/**", "stakpak://yourdomain.com/test/**"]
include_tags = ["production", "stable"]
exclude_tags = ["dev", "test", "experimental"]

# Development profile - more permissive settings for development
# Inherits from 'all' profile and extends with development-specific tools
[profiles.development]
api_key = "dev_api_key_here"

```

--------------------------------

### Create Stakpak Rule Book using CLI

Source: https://stakpak.gitbook.io/docs/how-it-works/rulebooks/how-to-write-a-rulebook

This snippet demonstrates how to create or update a Stakpak Rule Book using the command-line interface. It requires a Markdown file with frontmatter specifying the URI, description, and tags for the rule book. The 'stakpak rb apply' command is used to upload the rule book.

```markdown
---
uri: stakpak://my-org/deployment-guide.md
description: Standard deployment procedures for production
tags:
  - deployment
  - production
  - sop
---

# Deployment Guide

Your deployment procedures and guidelines here...

```

```bash
stakpak rb apply rulebook-name.md
```

--------------------------------

### Stakpak Configuration for Development Profile

Source: https://stakpak.gitbook.io/docs/get-started/configure-stakpak

This TOML configuration defines settings for the 'development' profile in Stakpak. It extends the 'all' profile's allowed_tools and auto_approve lists with development-specific operations. It also specifies rulebook inclusion and exclusion patterns, along with global settings like machine name and gitignore auto-appending.

```toml
# Extends 'all' profile's allowed_tools with write operations for development
allowed_tools = ["view", "search_docs", "read_rulebook", "local_code_search", "create", "str_replace", "run_command"]

# Extends 'all' profile's auto_approve with additional development tools
auto_approve = ["view", "search_docs", "read_rulebook", "create"]

[profiles.development.rulebooks]
# Include development and test rulebooks
include = ["stakpak://yourdomain.com/dev/**", "stakpak://yourdomain.com/test/**"]
exclude = []
include_tags = ["dev", "test", "experimental"]
exclude_tags = []

# Global settings that apply to all profiles
[settings]
# Machine name for device identification
machine_name = "my-development-machine"

# Automatically append .stakpak to .gitignore files
auto_append_gitignore = true

```

--------------------------------

### List Available Stakpak Rule Books

Source: https://stakpak.gitbook.io/docs/how-it-works/rulebooks/how-to-write-a-rulebook

This command retrieves a list of all Stakpak Rule Books that the user has access to. It's a simple command to check your available rule books.

```bash
stakpak rulebooks get
```

--------------------------------

### Run Stakpak in Warden Sandbox

Source: https://stakpak.gitbook.io/docs/how-it-works/warden-guardrails

This command executes Stakpak within a Warden sandbox environment. It mounts the Stakpak configuration file and AWS credentials into the sandbox for the agent to use. The `-v` flag specifies volume mounts, with `:ro` indicating read-only access.

```bash
stakpak warden -v ~/.stakpak/config.toml:/home/agent/.stakpak/config.toml:ro -v ~/.aws:/home/agent/.aws:ro
```

--------------------------------

### Delete Stakpak Rule Book using CLI

Source: https://stakpak.gitbook.io/docs/how-it-works/rulebooks/how-to-write-a-rulebook

This command-line snippet shows how to delete an existing Stakpak Rule Book. It uses the 'stakpak rb delete' command followed by the URI of the rule book to be removed.

```bash
stakpak rb delete stakpak://my-org/old-guide.md
```
Tokens:
Raw