openclaw/AXorcist
openclaw/AXorcist
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 2 Wiki Activity

docs: add shared/tools guardrails

Browse Source
This commit is contained in:
Peter Steinberger 2025-11-17 07:15:31 +01:00
parent 02ba0ef1fc
commit ced6a3c4c9
1 changed files with 21 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
AGENTS.md
View File

@ -17,6 +17,7 @@ Shared guardrails distilled from the various `~/Projects/*/AGENTS.md` files (sta
- Stick to the package manager and runtime mandated by the repo (pnpm-only, bun-only, swift-only, go-only, etc.). Never swap in alternatives without approval.
- When editing shared guardrail scripts (runners, committer helpers, browser tools, etc.), mirror the same change back into the `agent-scripts` folder so the canonical copy stays current.
- Ask the user before adding dependencies, changing build tooling, or altering project-wide configuration.
- Keep the project’s `AGENTS.md` `<tools></tools>` block in sync with the full tool list from `TOOLS.md` so downstream repos get the latest tool descriptions.
### tmux & Long Tasks
- Run any command that could hang (tests, servers, log streams, browser automation) inside tmux using the repository’s preferred entry point.
@ -69,4 +70,24 @@ Shared guardrails distilled from the various `~/Projects/*/AGENTS.md` files (sta
- When editing UI code, follow the established component patterns (Tailwind via helper utilities, TanStack Query for data flow, etc.) and keep files under the preferred size limit by extracting helpers proactively.
Keep this master file up to date as you notice new rules that recur across repositories, and reflect those updates back into every workspace’s local guardrail documents.
</shared>
<tools>
# TOOLS
- `runner`: Bash shim that routes every command through the Bun guardrails (timeouts, git policy, trash-safe deletes); first call: `./runner -- echo usage` to see the usage banner.
- `git` / `bin/git`: Git shim that forces all git invocations through the runner and blocks destructive subcommands; first call: `./git --help` to confirm the wrapper and read git help.
- `scripts/committer`: Commit helper that stages only the paths you list and creates the commit safely; first call: `./runner scripts/committer` to print its usage prompt.
- `scripts/docs-list.ts`: Docs indexer that walks `docs/` and enforces required front-matter before printing summaries; first call: `./runner tsx scripts/docs-list.ts --help` (or run without flags to list docs).
- `scripts/browser-tools.ts`: Chrome DevTools/Debugger helper to remote-control Chrome (start profiles, navigate, eval JS, screenshots); first call: `./runner ts-node scripts/browser-tools.ts --help`.
- `scripts/runner.ts`: Bun implementation that powers the runner’s guardrails (timeouts, tmux nudges, git policy, safe deletes); first call: `./runner bun scripts/runner.ts --help` to show its usage banner.
- `bin/sleep`: Sleep shim that enforces the 30-second ceiling by dispatching through the runner; first call: `./bin/sleep --help` to view the underlying `sleep` usage.
- `xcp`: Command-line helper for managing Xcode projects and workspaces; first call: `./runner xcp --help` to see available subcommands.
- `oracle`: CLI that bundles a prompt plus selected files to hand off to another AI; first call: `npx -y @steipete/oracle --help` (run via `./runner npx -y @steipete/oracle --help` if keeping guardrails).
- `mcporter`: MCP launcher that runs any registered MCP server with one command; first call: `./runner npx mcporter --help` to see server discovery and flags.
- `iterm`: Full TTY-capable terminal launched via MCP for unrestricted shell access; first call: `./runner npx mcporter iterm --help` to view options and requirements.
- `firecrawl`: MCP-powered site fetcher that exports webpages to Markdown, even handling 404/500 responses; first call: `./runner npx mcporter firecrawl --help` to see fetch options.
- `XcodeBuildMCP`: MCP wrapper around Xcode build/test/simulator tooling; first call: `./runner npx mcporter XcodeBuildMCP --help` to see available tools and auth needs.
- `gh`: GitHub CLI for PRs, CI logs, releases, and repo queries; first call: `./runner gh help` (or `./runner gh --help`) to list top-level commands.
</tools>