magpie

https://github.com/yetone/magpie
Admin
magpie is a desktop application and local gateway that allows users to route and manage AI models...
Tokens:330,972
Snippets:1,810
Trust Score:9.7
License:MIT
Update:6 days ago
Show doc for...
Tokens:
Raw
### magpie daemon commands for service management

Source: https://github.com/yetone/magpie/blob/main/docs/reference.md

Commands to install, check status, restart, stop/start, uninstall, and toggle web serving for the magpie background service. The install command writes the service and starts it; run it again to pick up a new PATH or proxy. The web on command makes the service serve the browser page as well.

```sh
magpie daemon install    # write the service and start it; again, to take a new PATH or proxy
magpie daemon status     # running or not, its pid, file and logs, whether the gateway answers
magpie daemon restart    # after updating magpie
magpie daemon stop|start
magpie daemon uninstall  # stop it and remove the file
magpie daemon web on     # the service serves the browser page too; off stops it, no word shows it
```

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

### magpie plugin add ./alias.middleware.js

Source: https://github.com/yetone/magpie/blob/main/site/public/docs/plugins.html

Command to install the example middleware from a local file or a package with a 'magpie' middleware field in its package.json.

```shell
magpie plugin add ./alias.middleware.js   # or a package whose package.json has "magpie": { "middleware": "./mw.js" }
```

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

### Install Magpie from source with Go

Source: https://github.com/yetone/magpie/blob/main/docs/reference.md

Installs the latest Magpie version directly from source using the Go toolchain.

```sh
go install github.com/yetone/magpie@latest
```

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

### Install magpie via curl

Source: https://github.com/yetone/magpie/blob/main/README.md

Downloads and runs the magpie installer script. Mac builds are signed and notarised, and every build updates itself. Behind a firewall, use --proxy or --mirror.

```sh
curl -fsSL https://usemagpie.ai/install.sh | sh
```

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

### Go test: settings TestRanBefore

Source: https://github.com/yetone/magpie/blob/main/docs/subsystems/plugin-runtime.md

Runs the settings test TestRanBefore.

```bash
go test ./internal/settings/ -run TestRanBefore
```

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

### Install with proxy and set update mirror

Source: https://github.com/yetone/magpie/blob/main/docs/reference.md

Shows how to pass a proxy to the installer and how to set a GitHub download mirror for `magpie update`. The proxy accepts http, https, socks5, or socks5h; the mirror is a prefix placed before the release's GitHub URL. No mirror is used unless given, and SHA-256 checks still come from usemagpie.ai.

```sh
curl -fsSL https://usemagpie.ai/install.sh | sh -s -- --proxy http://127.0.0.1:7890
```

```sh
magpie update --mirror https://mirror.example/
```

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

### Install Claude Code in the container

Source: https://github.com/yetone/magpie/blob/main/site/public/docs/docker.html

Use this command to have Magpie download Anthropic's Claude Code build. It verifies the SHA-256 against Anthropic's manifest and stores it in /config/cache. Run again to get a newer version.

```shell
docker exec -it magpie magpie claude-code install
```

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

### Docker commands for setup, health, terminal, updates, and build

Source: https://github.com/yetone/magpie/blob/main/site/public/docs/docker.html

A collection of shell commands for managing the magpie container: setting ownership, starting with Compose, checking health, opening a terminal, pulling updates, and building the image from source.

```bash
sudo chown -R 65532:65532 ./config
```

```bash
docker compose up -d
```

```bash
docker exec -it magpie bash
```

```bash
docker pull ghcr.io/yetone/magpie:latest
```

```bash
docker rm -f magpie
```

```bash
docker compose pull && docker compose up -d
```

```bash
docker build -t magpie .
```

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

### Install opencode-claude-auth plugin via LLM prompt

Source: https://github.com/yetone/magpie/blob/main/internal/plugin/testdata/github/raw/griffinmartin/opencode-claude-auth/HEAD/README.md

Prompt to give to an LLM agent to install and configure the plugin automatically. The agent should follow the linked installation instructions.

```text
Install the opencode-claude-auth plugin and configure it by following: https://raw.githubusercontent.com/griffinmartin/opencode-claude-auth/main/installation.md
```

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

### Run update-mirror.test.cjs

Source: https://github.com/yetone/magpie/blob/main/internal/gui/tests/README.md

Executes the test file for update mirror settings and download source behavior.

```sh
node --test internal/gui/tests/update-mirror.test.cjs
```

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

### GET /api/hello

Source: https://github.com/yetone/magpie/blob/main/docs/integrating.md

Health check endpoint to verify the gateway is magpie and get its version.

```APIDOC
## GET /api/hello

### Description
Returns a JSON object with the name and version of the gateway, confirming it is magpie.

### Method
GET

### Endpoint
/api/hello

### Response
#### Success Response (200)
- **name** (string) - Always "magpie".
- **version** (string) - The version of magpie.

#### Response Example
{
  "name": "magpie",
  "version": "..."
}
```

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

### magpie CLI usage examples

Source: https://github.com/yetone/magpie/blob/main/site/public/index.html

Shows common magpie CLI commands: adding providers, assigning models to agents, creating model groups, listing agents, saving/using profiles, and launching the TUI. Presets like `deepseek` need only a key; local servers like `ollama` need none.

```bash
# add providers
magpie provider add deepseek sk-…      # a preset needs only the key
magpie provider add moonshot sk-…
magpie provider add ollama             # local servers need none

# give agents third-party models
magpie codex deepseek/deepseek-v4-pro
magpie claude moonshot/kimi-k3
magpie gemini zhipu/glm-5.3
magpie opencode claude/claude-sonnet-5 # your Claude plan, in OpenCode

# one model over several providers
magpie group add opus models=claude/claude-opus-5-5,copilot/claude-opus-5.5 routing=order
magpie claude group/opus

magpie ls                              # every agent and its model
magpie save work && magpie use work    # profiles
magpie tui                             # the whole app, in the terminal
```
Tokens:
Raw