Skip to content

Commit 9650d7e

Browse files
authored
docs: document sync and publint commands in README (#48)
* chore(ci): force deploy * docs: document sync and publint commands in README
1 parent 8644691 commit 9650d7e

2 files changed

Lines changed: 10 additions & 3 deletions

File tree

.changeset/gray-anaconda-readme.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
'@bomb.sh/tools': patch
3+
---
4+
5+
Updates the README to document the `bsh sync` and `bsh publint` commands and accurately describe how `sync` links agent skills into a project

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,16 @@ This package is an internal CLI intended to standardize tooling across all Bombs
44

55
If you'd like to use this package for your own projects, please consider forking. We are not accepting issues on this repo.
66

7-
- `init` command for scaffolding new projects, which clones [our `template` repo](https://github.com/bombshell-dev/template)
7+
- `bsh init` command for scaffolding new projects, which clones [our `template` repo](https://github.com/bombshell-dev/template)
88
- `bsh dev` command, using `node --experimental-transform-types --watch-path=./src/`
99
- `bsh build` command, using [`tsdown`](https://tsdown.dev/) (ESM, unbundled)
1010
- `bsh test` command, using [`vitest`](https://vitest.dev/)
1111
- `bsh format` command, using [`oxfmt`](https://oxc.rs/docs/guide/usage/formatter)
12-
- `bsh lint` command, using [`oxlint`](https://oxc.rs/docs/guide/usage/linter), [`publint`](https://publint.dev/), [`knip`](https://knip.dev), [`tsgo`](https://npmx.dev/@typescript/native-preview)
12+
- `bsh lint` command, using [`oxlint`](https://oxc.rs/docs/guide/usage/linter), [`knip`](https://knip.dev), [`tsgo`](https://npmx.dev/@typescript/native-preview)
13+
- `bsh publint` command, using [`publint`](https://publint.dev/)
14+
- `bsh sync` command, which links our shared [agent skills](#agent-skills) into your project
1315
- shared `tsconfig.json` file
1416

1517
## Agent Skills
1618

17-
If you use an AI coding agent, run `pnpm bsh sync` to copy skill files into your project's `skills/` directory. Claude Code users: add `@AGENTS.md` to your project's `CLAUDE.md`.
19+
If you use an AI coding agent, run `pnpm bsh sync` to symlink this package's skill files into your project's `skills/` directory. Synced skills are automatically added to your `.gitignore`, and an index of them is maintained in your `AGENTS.md`. Claude Code users: add `@AGENTS.md` to your project's `CLAUDE.md`.

0 commit comments

Comments
 (0)