{"id":50216283,"url":"https://github.com/rogerchappel/shellgarden","last_synced_at":"2026-05-26T09:04:27.287Z","repository":{"id":360299779,"uuid":"1237540917","full_name":"rogerchappel/shellgarden","owner":"rogerchappel","description":"Fixture-backed shell command examples with deterministic local transcripts.","archived":false,"fork":false,"pushed_at":"2026-05-25T20:05:20.000Z","size":52,"stargazers_count":0,"open_issues_count":2,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-05-25T22:09:22.156Z","etag":null,"topics":["cli","doctest","fixtures","shell","testing","transcripts","typescript"],"latest_commit_sha":null,"homepage":"https://github.com/rogerchappel/shellgarden#readme","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/rogerchappel.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":"ROADMAP.md","authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":"AGENTS.md","dco":null,"cla":null}},"created_at":"2026-05-13T09:22:59.000Z","updated_at":"2026-05-25T20:05:25.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/rogerchappel/shellgarden","commit_stats":null,"previous_names":["rogerchappel/shellgarden"],"tags_count":null,"template":false,"template_full_name":null,"purl":"pkg:github/rogerchappel/shellgarden","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rogerchappel%2Fshellgarden","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rogerchappel%2Fshellgarden/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rogerchappel%2Fshellgarden/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rogerchappel%2Fshellgarden/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rogerchappel","download_url":"https://codeload.github.com/rogerchappel/shellgarden/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rogerchappel%2Fshellgarden/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33512343,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T03:12:49.672Z","status":"ssl_error","status_checked_at":"2026-05-26T03:12:47.976Z","response_time":63,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cli","doctest","fixtures","shell","testing","transcripts","typescript"],"created_at":"2026-05-26T09:04:11.203Z","updated_at":"2026-05-26T09:04:27.279Z","avatar_url":"https://github.com/rogerchappel.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ShellGarden 🪴\n\nShellGarden keeps shell examples alive. Declare commands once, point them at tiny fixture directories, and harvest deterministic transcripts you can trust in READMEs, tests, and agent handoffs.\n\nIt is local-first: no telemetry, no hidden network calls, and no mutation outside the garden path you ask it to inspect.\n\n## Install\n\n```bash\nnpm install -g shellgarden\n```\n\nFor local development:\n\n```bash\nnpm install\nnpm run build\nnode dist/index.js --help\n```\n\n## Quick start\n\n```bash\nshellgarden init ./demo\ncd demo\nshellgarden check . --update\nshellgarden check .\nshellgarden report . --format json\nshellgarden explain .\n```\n\nA garden config looks like this:\n\n```json\n{\n  \"version\": 1,\n  \"name\": \"docs-examples\",\n  \"defaultTimeoutMs\": 5000,\n  \"gardens\": [\n    {\n      \"id\": \"read-file\",\n      \"fixture\": \"fixtures/read-file\",\n      \"commands\": [\n        {\n          \"id\": \"print-message\",\n          \"run\": \"cat message.txt\",\n          \"expectExit\": 0,\n          \"transcript\": \"transcripts/read-file-print-message.txt\"\n        }\n      ]\n    }\n  ]\n}\n```\n\n## Commands\n\n- `shellgarden init \u003cdir\u003e` creates a small demo garden.\n- `shellgarden check \u003cdir\u003e [--format text|json] [--update] [--dry-run] [--strict-warnings] [--filter id]` executes safe examples and compares transcripts.\n- `shellgarden report \u003cdir\u003e --format json` emits machine-readable results.\n- `shellgarden run \u003cdir\u003e --execute` is an explicit execution alias; without `--execute`, it dry-runs.\n- `shellgarden explain \u003cdir\u003e` prints the execution plan and safety notes.\n- `shellgarden list \u003cdir\u003e` prints a tab-separated inventory of garden commands.\n\n## Exit codes\n\n- `0` — garden is clean.\n- `1` — findings exceeded policy, such as exit or transcript mismatch.\n- `2` — invalid input/config.\n\n## Safety model\n\nShellGarden runs commands only inside declared fixture directories. It rejects path escapes and blocks obviously risky commands (`sudo`, destructive `rm`, common network tools, broad chmods, and system writes). The environment is normalized with UTC locale/timezone settings and output paths are replaced with `\u003cworkspace\u003e`.\n\nThis is not a sandbox. Treat garden commands like test scripts: review them before accepting contributions. See [docs/SAFETY.md](docs/SAFETY.md) for the full boundary model.\n\n## Examples\n\nTry the repository fixtures:\n\n```bash\nnode dist/index.js check fixtures/pass\nnode dist/index.js report fixtures/pass --format json\nnode dist/index.js explain fixtures/pass\n```\n\nThe `fixtures/warn`, `fixtures/fail`, and `fixtures/unsafe` gardens document warning, policy failure, and safety-blocked cases.\n\n## Verify\n\n```bash\nnpm test\nnpm run check\nnpm run smoke\nnpm run package:smoke\nnpm run release:check\n```\n\n## Why this exists\n\nREADME commands rot quietly. Agents copy stale examples loudly. ShellGarden gives small projects a way to keep examples executable, deterministic, and easy to inspect.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frogerchappel%2Fshellgarden","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frogerchappel%2Fshellgarden","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frogerchappel%2Fshellgarden/lists"}