Imported from sdinc/openclaw-sandbox (
AGENTS.md). Install upstream withnpx skills add sdinc/openclaw-sandbox. Copyright stays with the author.
See README.md for purpose, requirements, and usage.
Agent Development Workflow
When making changes to this repository, follow this workflow:
-
Make all file edits - Complete all necessary changes before testing
-
Build and test locally with cache - Always test locally before committing:
make build-cached # Uses buildx cache for faster builds make test # Run full test suite- First run will create the buildx builder automatically
- Subsequent builds will be much faster due to caching
- Tests must pass locally before proceeding
-
Commit and push changes - Only after local tests pass:
git add . git commit -m "descriptive message" git push -
Monitor CI - Verify GitHub Actions passes with same results
Build and Cache Management
Available Make Targets:
make build- Standard Docker build (no cache)make build-cached- Build with buildx cache (recommended, matches CI)make test- Full test suite with version checksmake test-quick- Fast smoke test (no version check)make test-openclaw- OpenClaw-specific functionality testsmake bump- Bump OpenClaw version across all codebase files (Dockerfile,Makefile,package.json,pyproject.toml)- Set
BETA=1to allow bumping to beta/pre-release versions (e.g.,make bump BETA=1) - Set
YES=1to auto-approve the version bump non-interactively (e.g.,make bump YES=1)
- Set
make clean- Remove generated files and Docker imagesmake build-cached-cleanup- Remove buildx builder and cache
Cache Location:
- Local cache:
/tmp/.buildx-cache - CI cache:
/tmp/.buildx-cache(in GitHub Actions runner)
First Time Setup:
The build-cached target will automatically create the openclaw-builder buildx builder on first use.
Version Bumping
The repository supports automated version bumping using bump.py via make bump.
- It fetches the latest OpenClaw release tag from GitHub and replaces the old version in all relevant files.
- To include beta/pre-release versions, run:
make bump BETA=1 - To run non-interactively (useful for automation):
make bump YES=1
Agent Notes
- ALWAYS run
make build-cached && make testbefore git commit - To configure trusted workspaces and auto-approved commands for the Google Antigravity CLI (
agy), refer to the Configuration section inREADME.mdregardingsettings.json. - Prefer running tools inside the container via
make run cmd="..."(e.g.make run cmd="gh release create ..."). - Do not run
gitcommands viamake run(run git on the host). - The container runs as
rootby default, so home is/root. - If you need additional tools later, prefer adding them to
Dockerfileand documenting them inREADME.md. - When editing multiple files, complete all edits before running
make build-cachedandmake test. - Test failures will exit with non-zero status - do not commit if tests fail.