From c53a99ef53d4dac4a9f0d7a6d00c782155e60d30 Mon Sep 17 00:00:00 2001 From: Bousalih Hamza Date: Mon, 6 Apr 2026 01:31:22 +0100 Subject: [PATCH] docs: simplify setup documentation and remove outdated sections --- docs/setup.md | 44 +++----------------------------------------- 1 file changed, 3 insertions(+), 41 deletions(-) diff --git a/docs/setup.md b/docs/setup.md index d0cc416..e55a443 100644 --- a/docs/setup.md +++ b/docs/setup.md @@ -1,47 +1,11 @@ # Setup -Develop the BSH Git CLI locally, link it into other repositories if needed, and turn on debug logging when something misbehaves. **Invoking the CLI:** this documentation uses only **`npx @bshsolutions/git`** (no global install). - -```text -Setup -├── Prerequisites -├── Develop this repo -│ └── Debug logging -├── Local link (try the package in another project) -└── Production-style usage -``` - -## Prerequisites - -- **Node.js** and npm -- **Git** (required for `commit` hook install/uninstall) - -## Develop this repo - -From the repository root: - -```sh -npm install -npm run build -``` - -Run the CLI with: - -```sh -npx @bshsolutions/git --help -``` - -### Debug logging - -```sh -LOG_LEVEL=debug npx @bshsolutions/git commit validate -``` - -> **Tip:** While hacking on this repo, prefer the package scripts `npm run cli` and `npm run cli:debug` so the local `tsx` entry runs with `ENV=local`. - ## Local link (try the package in another project) ```sh +npm run install +npm run build # or watch + # In this repository npm link @@ -62,5 +26,3 @@ After publishing or when using `npx`: ```sh npx @bshsolutions/git --help ``` - -For installing the commit-msg hook in consumer repositories, see [**Commit**](commit.md). Unless `ENV=local` is set, the hook invokes the CLI via `npx @bshsolutions/git`.