Skip to content

docs: document sync and publint commands in README #48

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
natemoo-re merged 3 commits into from
Jul 18, 2026
Merged

docs: document sync and publint commands in README #48

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ee096b2
chore(ci): force deploy
natemoo-re Jul 10, 2026
e8b3c23
docs: document sync and publint commands in README
natemoo-re Jul 18, 2026
58aad40
Merge branch 'main' into readme-sync-command
natemoo-re Jul 18, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/gray-anaconda-readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@bomb.sh/tools': patch
---

Updates the README to document the `bsh sync` and `bsh publint` commands and accurately describe how `sync` links agent skills into a project
8 changes: 5 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,16 @@ This package is an internal CLI intended to standardize tooling across all Bombs

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

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

## Agent Skills

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`.
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`.
Loading