From 85064f6cd2e6281ad7a1fb84d6ca99f0607dd20c Mon Sep 17 00:00:00 2001 From: Claude Date: Tue, 3 Mar 2026 02:25:35 +0000 Subject: [PATCH 1/3] docs(rustdoc): align crate docs with README, add doc review to maintenance checklist - Update lib.rs command table from 68+ to 100+ with all categories matching README (byte tools, disk, pipeline categories; added pushd/popd/dirs, declare/typeset/let, trap/caller/getopts/shopt, paste/column/diff/comm/strings/tac/rev/seq/expr, mktemp/chown/ln/realpath, od/xxd/hexdump, df/du, watch/yes/kill) - Add logging_guide to Guides section, consolidate threat_model into Guides - Fix Python README command count from 68+ to 100+ - Add dedicated Rust docs and Python docs review sections to 012-maintenance.md checklist covering lib.rs alignment, doc module completeness, and Python binding docs accuracy https://claude.ai/code/session_01TY6qrBf9zut918FWh7QhjB --- crates/bashkit-python/README.md | 4 ++-- crates/bashkit/src/lib.rs | 23 ++++++++++++----------- specs/012-maintenance.md | 23 +++++++++++++++++++++-- 3 files changed, 35 insertions(+), 15 deletions(-) diff --git a/crates/bashkit-python/README.md b/crates/bashkit-python/README.md index 78d362d6..16fe6535 100644 --- a/crates/bashkit-python/README.md +++ b/crates/bashkit-python/README.md @@ -15,7 +15,7 @@ print(result.stdout) # Hello, World! ## Features - **Sandboxed execution** — all commands run in-process with a virtual filesystem, no containers needed -- **68+ built-in commands** — echo, cat, grep, sed, awk, jq, curl, find, and more +- **100+ built-in commands** — echo, cat, grep, sed, awk, jq, curl, find, and more - **Full bash syntax** — variables, pipelines, redirects, loops, functions, arrays - **Resource limits** — protect against infinite loops and runaway scripts - **Framework integrations** — LangChain, PydanticAI, and Deep Agents @@ -145,7 +145,7 @@ print(result.stdout) # Alice ## Features - **Sandboxed, in-process execution**: All commands run in isolation with a virtual filesystem -- **68+ built-in commands**: echo, cat, grep, sed, awk, jq, curl, find, and more +- **100+ built-in commands**: echo, cat, grep, sed, awk, jq, curl, find, and more - **Full bash syntax**: Variables, pipelines, redirects, loops, functions, arrays - **Resource limits**: Protect against infinite loops and runaway scripts diff --git a/crates/bashkit/src/lib.rs b/crates/bashkit/src/lib.rs index 6a747ba5..c401b5b2 100644 --- a/crates/bashkit/src/lib.rs +++ b/crates/bashkit/src/lib.rs @@ -15,20 +15,23 @@ //! - **Experimental: Git** - Virtual git operations on the VFS (`git` feature) //! - **Experimental: Python** - Embedded Python via [Monty](https://github.com/pydantic/monty) (`python` feature) //! -//! # Built-in Commands (68+) +//! # Built-in Commands (100+) //! //! | Category | Commands | //! |----------|----------| -//! | Core | `echo`, `printf`, `cat`, `read` | -//! | Navigation | `cd`, `pwd`, `ls`, `find` | +//! | Core | `echo`, `printf`, `cat`, `nl`, `read` | +//! | Navigation | `cd`, `pwd`, `ls`, `find`, `pushd`, `popd`, `dirs` | //! | Flow control | `true`, `false`, `exit`, `return`, `break`, `continue`, `test`, `[` | -//! | Variables | `export`, `set`, `unset`, `local`, `shift`, `source`, `.` | -//! | Text processing | `grep`, `sed`, `awk`, `jq`, `head`, `tail`, `sort`, `uniq`, `cut`, `tr`, `wc` | -//! | File operations | `mkdir`, `rm`, `cp`, `mv`, `touch`, `chmod`, `rmdir` | +//! | Variables | `export`, `set`, `unset`, `local`, `shift`, `source`, `.`, `eval`, `readonly`, `times`, `declare`, `typeset`, `let` | +//! | Shell | `bash`, `sh` (virtual re-invocation), `:`, `trap`, `caller`, `getopts`, `shopt` | +//! | Text processing | `grep`, `sed`, `awk`, `jq`, `head`, `tail`, `sort`, `uniq`, `cut`, `tr`, `wc`, `paste`, `column`, `diff`, `comm`, `strings`, `tac`, `rev`, `seq`, `expr` | +//! | File operations | `mkdir`, `mktemp`, `rm`, `cp`, `mv`, `touch`, `chmod`, `chown`, `ln`, `rmdir`, `realpath` | //! | File inspection | `file`, `stat`, `less` | //! | Archives | `tar`, `gzip`, `gunzip` | -//! | Utilities | `sleep`, `date`, `basename`, `dirname`, `timeout`, `wait`, `xargs`, `tee` | -//! | Shell | `bash`, `sh` (virtual re-invocation), `eval`, `:` | +//! | Byte tools | `od`, `xxd`, `hexdump` | +//! | Utilities | `sleep`, `date`, `basename`, `dirname`, `timeout`, `wait`, `watch`, `yes`, `kill` | +//! | Disk | `df`, `du` | +//! | Pipeline | `xargs`, `tee` | //! | System info | `whoami`, `hostname`, `uname`, `id`, `env`, `printenv`, `history` | //! | Network | `curl`, `wget` (requires [`NetworkAllowlist`]) //! | Experimental | `python`, `python3` (requires `python` feature), `git` (requires `git` feature) @@ -349,10 +352,8 @@ //! - [`custom_builtins_guide`] - Creating custom builtins //! - `python_guide` - Embedded Python (Monty) guide (requires `python` feature) //! - [`compatibility_scorecard`] - Feature parity tracking -//! -//! # Resources -//! //! - [`threat_model`] - Security threats and mitigations +//! - `logging_guide` - Structured logging with security (requires `logging` feature) //! //! # Ecosystem //! diff --git a/specs/012-maintenance.md b/specs/012-maintenance.md index f637ac86..973620d4 100644 --- a/specs/012-maintenance.md +++ b/specs/012-maintenance.md @@ -46,11 +46,30 @@ regressions, stale docs, dependency rot, and security gaps. ### 4. Documentation -- [ ] `README.md` feature list matches implemented builtins +#### Rust Docs (crate-level + guides) + +- [ ] `lib.rs` crate-level docs command count matches reality +- [ ] `lib.rs` command table categories and entries match `README.md` +- [ ] `lib.rs` Guides section lists all doc modules (custom_builtins, python, compatibility, threat_model, logging) +- [ ] `lib.rs` feature list matches `README.md` feature list +- [ ] `lib.rs` code examples compile: `cargo test --doc --all-features` - [ ] `crates/bashkit/docs/compatibility.md` scorecard up to date - [ ] `crates/bashkit/docs/threat-model.md` matches `specs/006-threat-model.md` -- [ ] `crates/bashkit/docs/python.md` matches current python feature status +- [ ] `crates/bashkit/docs/custom_builtins.md` API examples match current trait signatures +- [ ] `crates/bashkit/docs/logging.md` matches current logging feature behavior - [ ] Rustdoc builds clean: `cargo doc --all-features` (no warnings) + +#### Python Docs + +- [ ] `crates/bashkit-python/README.md` command count matches reality +- [ ] `crates/bashkit-python/README.md` feature list matches current Python bindings +- [ ] `crates/bashkit-python/README.md` API reference matches actual Python exports +- [ ] `crates/bashkit/docs/python.md` matches current python feature status +- [ ] Python docstrings match behavior (spot-check `Bash`, `BashTool`, `ScriptedTool`) + +#### General + +- [ ] `README.md` feature list matches implemented builtins - [ ] `CONTRIBUTING.md` instructions still accurate - [ ] `CHANGELOG.md` has entries for all changes since last release From 1a79578f35023350f36b8f1ac15f6b1eee425740 Mon Sep 17 00:00:00 2001 From: Claude Date: Tue, 3 Mar 2026 02:34:42 +0000 Subject: [PATCH 2/3] fix(docs): keep threat_model under Resources, not Guides https://claude.ai/code/session_01TY6qrBf9zut918FWh7QhjB --- crates/bashkit/src/lib.rs | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/crates/bashkit/src/lib.rs b/crates/bashkit/src/lib.rs index c401b5b2..8ae4ef6d 100644 --- a/crates/bashkit/src/lib.rs +++ b/crates/bashkit/src/lib.rs @@ -352,9 +352,12 @@ //! - [`custom_builtins_guide`] - Creating custom builtins //! - `python_guide` - Embedded Python (Monty) guide (requires `python` feature) //! - [`compatibility_scorecard`] - Feature parity tracking -//! - [`threat_model`] - Security threats and mitigations //! - `logging_guide` - Structured logging with security (requires `logging` feature) //! +//! # Resources +//! +//! - [`threat_model`] - Security threats and mitigations +//! //! # Ecosystem //! //! Bashkit is part of the [Everruns](https://everruns.com) ecosystem. From 1b966ea7a01642d9ac3d0f9cbb6f7786469b9fc1 Mon Sep 17 00:00:00 2001 From: Claude Date: Tue, 3 Mar 2026 02:57:51 +0000 Subject: [PATCH 3/3] chore: update cargo-vet exemption for ipnet 2.11.0 -> 2.12.0 https://claude.ai/code/session_01TY6qrBf9zut918FWh7QhjB --- supply-chain/config.toml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/supply-chain/config.toml b/supply-chain/config.toml index 9ff1b7e6..2161bd3d 100644 --- a/supply-chain/config.toml +++ b/supply-chain/config.toml @@ -571,7 +571,7 @@ version = "0.5.0" criteria = "safe-to-deploy" [[exemptions.ipnet]] -version = "2.11.0" +version = "2.12.0" criteria = "safe-to-deploy" [[exemptions.iri-string]]