Skip to content
This repository was archived by the owner on Oct 10, 2026. It is now read-only.

Configuration

Jump to bottom
Andre Ferreira edited this page Sep 30, 2026 · 11 revisions

Configuration

org/org.yaml

organization: my-org
teams: [engineering]
budgets: { per_run_usd: 5 }     # default run budget; --budget overrides
max_concurrent_runs: 2          # runs of this org at once
adapter: direct                 # mock | direct | claude-code; a chosen model overrides it
vault: ../vault                 # Obsidian vault, relative to the org directory
setup: auto                     # auto | off: the dependency install of worktree runs

org/models.yaml

providers: {}
tiers:
  strong: anthropic/claude-sonnet-5
  cheap: openrouter/qwen/qwen3-coder
  decision: openrouter/typesafe/jev-router   # or jev-latest with TYPESAFE_API_KEY
roles:
  backend: { model: openai/gpt-5 }           # per-role override
gates:
  judge: anthropic/claude-haiku-4-5          # judge and review checks

shibaox tiers / shibaox tiers set and /tiers in the dashboard edit tiers, judge, adapter and budget without touching the files by hand (comments are kept).

org/teams/<team>.yaml

team: engineering
lead: team-leader
roles: [team-leader, analyst, backend]
gates: [tests]                    # injected into every workflow of the team
workflows: [hello-feature, land-feature]

org/roles/<role>.yaml

role: backend
description: Implements changes with tests.
system_prompt: prompts/backend.md   # optional, relative to the org
model_tier: strong                  # strong | cheap
runtime: claude-code                # optional: which runtime an anthropic/ model uses
tools: [read, write, git, node, pnpm]
permissions:
  fs: [workspace]
  network: [github.com]             # hosts it may fetch; '*' = any
  approval_required: [push, deploy]  # what asks a human: push | deploy | execute | network | protected (only these)
  protected: ['infra/**', '*.lock']  # files a task may not write without a protected approval (*.lock = any depth)
capabilities: [orchestrate, memory] # start_workflow; remember/recall
mcp: [playwright]                   # catalog MCP servers whose tools it gets, in every runtime
skills: [e2e-checklist]             # org/skills/<id>/SKILL.md appended to its prompt
max_steps: 12                       # direct adapter tool-loop steps
max_turns: 60                       # Claude Code agent turns
budget_usd: 1                       # cap per task within the run budget

org/catalog/<id>.yaml

Capabilities the org knows about: id, type (team | workflow | skill | plugin | mcp | tool), description, tags. An mcp entry with a server: block (transport: stdio|http, command/args or url, env, env_keys from the vault, headers, tools allowlist, timeout_ms) can be listed under a role's mcp:; see MCP and skills. Entries without a server are markers for autorouting (Memory).

org/skills/<id>/SKILL.md

A skill: Markdown with optional frontmatter, appended to the prompt of every role that lists it under skills:.

org/workflows/<workflow>.yaml

workflow: land-feature
team: engineering
description: Analyse, implement, test, judge, approve, commit and land.
start: analyse
nodes:
  analyse:   { type: task, role: analyst, instruction: "Analyse the request and list the files to touch.", next: implement }
  implement: { type: task, role: backend, instruction: "Implement the request. Keep tests green.", next: qa }
  qa:        { type: gate, gates: [tests], on_pass: judge, on_fail: implement, max_retries: 2 }
  judge:     { type: decide, by: team-leader, question: "Is the work ready to ship?", options: [ship, rework], next: { ship: ship, rework: implement } }
  ship:      { type: human, action: approve-push, prompt: "Land this on the base branch?", next: commit }
  commit:    { type: git, action: commit, next: merge }
  merge:     { type: git, action: merge }

conversation: true marks a chat workflow (one task, in place, the thread carried between turns). See Concepts for every node type and Gates for org/gates/*.yaml.

org/routines/<id>.yaml

Routines as code (loaded with shibaox routine sync --org): routine, on (cron, github + label/repo/branch, url, file, command), workflow, input, project (relative to the org), every, mode, max_daily_usd, adapter, budget_usd, enabled. See Routines.

<project>/shibaox.yaml

Optional, at the root of a project: what a run needs to know about it that cannot be guessed, or is guessed wrong.

setup: pnpm install --frozen-lockfile   # what a fresh worktree runs first; false for nothing (quote words like "no")
setup_timeout_ms: 600000
tests: pnpm test                        # the `tests` check (detected when absent)
lint: pnpm lint                         # the `lint` check (detected when absent)
protected: ['.github/**']               # files no run may write without a `protected` approval (see Security)

The file is read from the run's worktree, so it must be committed to count in worktree mode. Without setup, the install is detected from the lockfile (of the project, or of the monorepo above it), frozen: pnpm install --frozen-lockfile, yarn install --frozen-lockfile, bun install --frozen-lockfile, npm ci (or npm install --no-package-lock without any lockfile), uv sync --frozen, composer install --no-interaction, go mod download, cargo fetch --locked, bundle install. A tool that is not installed skips the step; see Worktrees for what the step runs and how to turn it off.

~/.shibaox/daemon.yaml

Every key optional:

max_concurrent_runs: 4
approval_timeout_minutes: 120
channels:
  macos: { enabled: true }
  github: { enabled: true }   # reports of `run --issue` runs as comments on the issue
  telegram:
    bot_token_env: SHIBAOX_TELEGRAM_TOKEN
    chat_id: 123456789
    org: ./org                  # relative paths resolve next to this file
    project: /path/to/project
    workflow: chat
    # adapter: claude-code
listen:                         # a network listener next to the socket (see Remote daemon)
  host: 0.0.0.0
  port: 7433
  token_env: SHIBAOX_DAEMON_TOKEN
  # tls: { cert: ./cert.pem, key: ./key.pem }
projects: [/srv/app]            # what a remote dashboard offers as projects
projects_dir: /projects         # …plus every git repository directly inside this directory

~/.shibaox/remote.json

Written by shibaox remote set <url> <token> (0600): { "baseUrl": "http://box:7433", "token": "…" }. While it exists every command goes to that daemon; shibaox remote clear removes it.

Environment

Variable
SHIBAOX_HOME the home directory (default ~/.shibaox)
SHIBAOX_NO_AUTOSTART=1 never start the daemon on demand
SHIBAOX_REMOTE, SHIBAOX_REMOTE_TOKEN a daemon on another machine and its token (over remote.json; --remote <url> sets the first for one command)
SHIBAOX_DAEMON_TOKEN on the server: the token shibaox serve expects (the vault is the better place)
SHIBAOX_NO_MOTION=1 no animations in the dashboard
SHIBAOX_APP the installer checkout (shibaox upgrade)
TYPESAFE_API_KEY, SHIBAOX_JEV_BASE_URL Jev through TypeSafe
SHIBAOX_REAL_TESTS=1 enables the real-call tests

Provider keys belong in the vault (shibaox keys set); the environment stays a fallback.

Start

Using Shibaox

Reference

Clone this wiki locally