Skip to content

Simplify setup documentation and remove outdated sections #13

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
hamza-bousalih merged 1 commit into from
Apr 6, 2026
Merged

Simplify setup documentation and remove outdated sections #13

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
44 changes: 3 additions & 41 deletions docs/setup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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

Expand All @@ -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`.
Loading