Surfwind

https://github.com/wowyuarm/surfwind
Admin
Surfwind is an unofficial, non-interactive agent-first Rust CLI bridge designed to drive the local...
Tokens:2,098
Snippets:32
Trust Score:6.5
License:MIT
Update:2 months ago
Show doc for...
Tokens:
Raw
### Install surfwind from source

Source: https://github.com/wowyuarm/surfwind/blob/main/README.md

Instructions for cloning the repository and building the binary using Cargo.

```bash
# Clone the repository
git clone https://github.com/wowyuarm/surfwind.git
cd surfwind

# Build and install locally
cargo install --path .

# Or build without installing
cargo build
# The binary will be at target/release/surfwind
```

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

### Build and Development Commands

Source: https://github.com/wowyuarm/surfwind/blob/main/AGENTS.md

Standard commands for building, testing, linting, and running the surfwind CLI locally.

```bash
# build
cargo build

# test
cargo test
cargo test --test integration_tests

# lint / format / type-check
cargo fmt --all
cargo clippy --all-targets --all-features
cargo check

# run locally
cargo run -- status --no-auto-launch
cargo run -- models --no-auto-launch
cargo run -- exec --workspace /path/to/repo --output stream-json --no-persist "summarize this repository"
cargo run -- resume --last "continue"
```

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

### Execute surfwind commands

Source: https://github.com/wowyuarm/surfwind/blob/main/README.md

Basic commands for checking status, listing models, and executing prompts within a workspace.

```bash
# Check runtime status
surfwind status

# List available models
surfwind models

# Run a simple prompt
surfwind exec --workspace /path/to/repo "summarize this codebase"

# Get structured output
surfwind exec --workspace /path/to/repo --output stream-json "explain the main function"
```

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

### Execute Surfwind CLI commands

Source: https://github.com/wowyuarm/surfwind/blob/main/skills/surfwind/SKILL.md

Common CLI patterns for managing workspaces, executing tasks, and handling output formats.

```bash
surfwind status --no-auto-launch
surfwind models --no-auto-launch
surfwind exec --workspace /repo --output stream-json --no-persist "summarize this repo"
surfwind exec --workspace /repo --output-last-message "reply with the final answer only"
surfwind exec --workspace /repo --json "plan the next refactor"
surfwind exec --workspace /repo --timeout-seconds 120 --result-file ./artifacts/result.json --output-last-message-file ./artifacts/final.txt "solve within deadline"
surfwind exec --workspace /repo --strict-json --json "reply with a single JSON object"
surfwind exec --workspace /repo --output-schema ./result.schema.json --json "respond using the requested schema"
surfwind resume <run-id> --output stream-json "continue"
surfwind resume --last "continue"
surfwind runs --status failed --workspace /repo
surfwind show latest
surfwind events latest
surfwind settings keys
surfwind settings describe output
```

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

### Architecture Flow Diagram

Source: https://github.com/wowyuarm/surfwind/blob/main/AGENTS.md

Visual representation of the data flow between the CLI, agent, runtime, and runstore components.

```text
Caller/Script
   |
   v
src/cli.rs  -->  src/agent/*  -->  src/runtime/*  --> Windsurf language_server
   |                  |
   |                  v
   +------------> src/runstore.rs (persisted run JSON records)
```

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

### Default local state directory structure

Source: https://github.com/wowyuarm/surfwind/blob/main/README.md

The default directory structure used by surfwind for storing settings, runs, and logs.

```text
~/.surfwind/
  settings.json
  runs/
  logs/
```
Tokens:
Raw