contribute-now 0.7.1 → 0.7.2-dev.2734078

package/README.md

@@ -14,7 +14,7 @@ It natively supports multiple workflow models and commit conventions, with AI-po
 
 ## Workflow Modes
 
-Pick the model that matches your project during `contrib setup`. contribute-now adapts its commands to your chosen workflow automatically — no manual branch names to remember.
+Pick the model that matches your project during `cn setup`. contribute-now adapts its commands to your chosen workflow automatically — no manual branch names to remember.
 
 | Mode | Branches | Strategy | Default |
 |------|----------|----------|:-------:|
@@ -37,17 +37,21 @@ contribute-now validates commit messages and guides your AI toward the right for
 ## Quick Start
 
 ```bash
-npx contribute-now setup
+bunx contribute-now setup
 ```
 
 Or install globally:
 
 ```bash
-npm install -g contribute-now
-contrib setup
+bun install -g contribute-now
+contribute setup
 ```
 
-> `contrib`, `contribute`, and `cn` all invoke the same binary — use whichever you prefer.
+`contribute-now` now runs on Bun at runtime. Use `bunx` for one-off execution and `bun install -g` for a global install.
+
+> `contribute` is the primary command; `cn` is the short alias for the same binary — use whichever you prefer.
+>
+> The older `contrib` alias is being phased out. Please switch to `contribute` or `cn`.
 >
 > **Fun fact:** `cn` is shorter than `git`. Yes, your workflow command is now faster to type than git itself. 🚀
 
@@ -56,21 +60,29 @@ contrib setup
 ## Installation
 
 ```bash
-# npm
-npm install -g contribute-now
+# one-off
+bunx contribute-now setup
 
-# bun
+# global
 bun install -g contribute-now
 ```
 
-Once installed, you can use any of the three aliases:
+If you prefer to install the package from npm, install Bun first and then install `contribute-now`:
+
+```bash
+npm install -g bun
+npm install -g contribute-now
+```
+
+Once installed, you can use either alias:
 
 ```bash
-contrib setup     # classic
-contribute setup  # spelled out
-cn setup          # shortest — even shorter than git!
+contribute setup  # primary command — spelled out
+cn setup          # short alias — even shorter than git!
 ```
 
+> The legacy `contrib` alias still works but is being phased out. Prefer `contribute` or `cn`.
+
 ## Prerequisites
 
 - **[Git](https://git-scm.com/)** — required
@@ -81,12 +93,12 @@ cn setup          # shortest — even shorter than git!
 
 ## Commands
 
-### `contrib setup`
+### `cn setup`
 
 Interactive setup wizard. Configures your repo's workflow mode, commit convention, your role, branch/remote names, and AI provider settings. Writes local config to `.git/contribute-now/config.json` by default.
 
 ```bash
-contrib setup
+cn setup
 ```
 
 Steps:
@@ -98,33 +110,33 @@ Steps:
 6. Confirm branch and remote names
 7. Write `.git/contribute-now/config.json` (or update `.contributerc.json` if that legacy file is still the active source)
 
-If you want to disable AI completely for a repo, run `contrib setup` and turn AI off, or set `"aiEnabled": false` in the active config file. Per-command `--no-ai` flags still work as one-off overrides when AI is enabled globally.
+If you want to disable AI completely for a repo, run `cn setup` and turn AI off, or set `"aiEnabled": false` in the active config file. Per-command `--no-ai` flags still work as one-off overrides when AI is enabled globally.
 
 If you want a cleaner output once you're familiar with the CLI, set `"showTips": false` in the active config file to hide the beginner quick guides and loading tips.
 
 ---
 
-### `contrib config`
+### `cn config`
 
 Inspect the active repo config or edit it without rerunning the full setup flow.
 
 ```bash
-contrib config
-contrib config --json
-contrib config --edit
+cn config
+cn config --json
+cn config --edit
 ```
 
 Use `--edit` to update workflow settings, branch names, commit convention, AI provider details, the stored Ollama Cloud API key, and to choose from the currently available Ollama Cloud models. Ollama Cloud uses the built-in default host and does not ask for a custom host URL.
 
 ---
 
-### `contrib sync`
+### `cn sync`
 
 Pull the latest changes from the correct remote branch based on your workflow and role.
 
 ```bash
-contrib sync         # with confirmation
-contrib sync --yes   # skip confirmation
+cn sync         # with confirmation
+cn sync --yes   # skip confirmation
 ```
 
 | Role | Clean Flow / Git Flow | GitHub Flow |
@@ -134,98 +146,98 @@ contrib sync --yes   # skip confirmation
 
 ---
 
-### `contrib start`
+### `cn start`
 
 Create a new feature branch from the correct base branch, with optional AI-powered branch naming.
 
 ```bash
 # Direct branch name
-contrib start feature/user-auth
+cn start feature/user-auth
 
 # Natural language — AI suggests the branch name
-contrib start "add user authentication"
+cn start "add user authentication"
 
 # Skip AI
-contrib start "add user authentication" --no-ai
+cn start "add user authentication" --no-ai
 ```
 
 ---
 
-### `contrib commit`
+### `cn commit`
 
 Stage your changes and create a validated, AI-generated commit message matching your configured convention.
 
 ```bash
-contrib commit                     # AI-generated message
-contrib commit --no-ai             # manual entry, still validated
-contrib commit --model gpt-4.1    # specific AI model
-contrib commit --group             # AI groups changes into atomic commits
+cn commit                     # AI-generated message
+cn commit --no-ai             # manual entry, still validated
+cn commit --model gpt-4.1    # specific AI model
+cn commit --group             # AI groups changes into atomic commits
 ```
 
 After the AI generates a message, you can **accept**, **edit**, **regenerate**, or **write manually**. Messages are always validated against your convention — with a soft warning if they don't match (you can still commit).
 
 **Group commit mode** (`--group`): AI analyzes all staged and unstaged changes, groups related files into logical atomic commits, and generates a commit message for each group. Great for splitting a large set of changes into clean, reviewable commits.
 
-If `aiEnabled` is set to `false` in `.contributerc.json`, `contrib commit` stays manual and `--group` is unavailable.
+If `aiEnabled` is set to `false` in `.contributerc.json`, `cn commit` stays manual and `--group` is unavailable.
 
 ---
 
-### `contrib update`
+### `cn update`
 
 Rebase your current branch onto the latest base branch, with AI guidance if conflicts occur.
 
 ```bash
-contrib update
-contrib update --no-ai   # skip AI conflict guidance
+cn update
+cn update --no-ai   # skip AI conflict guidance
 ```
 
 ---
 
-### `contrib submit`
+### `cn submit`
 
 Push your branch and open a pull request with an AI-generated title and description.
 
 ```bash
-contrib submit
-contrib submit --draft
-contrib submit --no-ai
-contrib submit --model gpt-4.1
+cn submit
+cn submit --draft
+cn submit --no-ai
+cn submit --model gpt-4.1
 ```
 
 ---
 
-### `contrib clean`
+### `cn clean`
 
 Delete merged branches and prune stale remote refs.
 
 ```bash
-contrib clean          # shows candidates, asks to confirm
-contrib clean --yes    # skip confirmation
+cn clean          # shows candidates, asks to confirm
+cn clean --yes    # skip confirmation
 ```
 
 ---
 
-### `contrib status`
+### `cn status`
 
 Show a sync status dashboard for your main, dev, and current branch.
 
 ```bash
-contrib status
+cn status
 ```
 
 ---
 
-### `contrib doctor`
+### `cn doctor`
 
 Diagnose the contribute-now CLI environment and configuration. Checks tools, dependencies, config, git state, fork setup, workflow, and environment.
 
 ```bash
-contrib doctor          # pretty-printed report
-contrib doctor --json   # machine-readable JSON output
+cn doctor          # pretty-printed report
+cn doctor --json   # machine-readable JSON output
 ```
 
 Checks include:
-- CLI version and runtime (Bun/Node)
+- CLI version and runtime (Bun)
 - git and GitHub CLI availability and authentication
 - active repo config validity and storage location
 - Git repo state (uncommitted changes, lock files, shallow clone)
@@ -234,45 +246,45 @@ Checks include:
 
 ---
 
-### `contrib log`
+### `cn log`
 
 Show a colorized, workflow-aware commit log. By default it shows only **local unpushed commits** — the changes you've made since the last push (or since branching off the base branch). Use flags to switch between different views.
 
 ```bash
-contrib log                # local unpushed commits (default)
-contrib log --remote       # commits on remote not yet pulled
-contrib log --full         # full history for the current branch
-contrib log --all          # commits across all branches
-contrib log -n 50          # change the commit limit (default: 20)
-contrib log -b feature/x   # log for a specific branch
-contrib log --no-graph     # flat view without graph lines
+cn log                # local unpushed commits (default)
+cn log --remote       # commits on remote not yet pulled
+cn log --full         # full history for the current branch
+cn log --all          # commits across all branches
+cn log -n 50          # change the commit limit (default: 20)
+cn log -b feature/x   # log for a specific branch
+cn log --no-graph     # flat view without graph lines
 ```
 
 When no upstream tracking is set (branch hasn't been pushed yet), the command automatically compares against the base branch from your config (e.g., `origin/dev`). Protected branches are highlighted, and the current branch is color-coded for quick orientation.
 
 ---
 
-### `contrib branch`
+### `cn branch`
 
 List branches with workflow-aware labels and tracking status.
 
 ```bash
-contrib branch             # local branches
-contrib branch --all       # local + remote branches
-contrib branch --remote    # remote branches only
+cn branch             # local branches
+cn branch --all       # local + remote branches
+cn branch --remote    # remote branches only
 ```
 
 Branches are annotated with workflow labels (e.g., base, dev, feature) and tracking info (upstream, gone, no remote).
 
 ---
 
-### `contrib hook`
+### `cn hook`
 
 Install or uninstall a `commit-msg` git hook that validates every commit against your configured convention — no Husky or lint-staged needed.
 
 ```bash
-contrib hook install     # writes .git/hooks/commit-msg
-contrib hook uninstall   # removes it
+cn hook install     # writes .git/hooks/commit-msg
+cn hook uninstall   # removes it
 ```
 
 - Automatically skips merge commits, fixup, squash, and amend commits
@@ -280,13 +292,13 @@ contrib hook uninstall   # removes it
 
 ---
 
-### `contrib validate`
+### `cn validate`
 
 Validate a commit message against your configured convention. Exits `0` if valid, `1` if not — useful in CI pipelines or custom hooks.
 
 ```bash
-contrib validate "📦 new: user auth module"     # exit 0
-contrib validate "added stuff"                   # exit 1
+cn validate "📦 new: user auth module"     # exit 0
+cn validate "added stuff"                   # exit 1
 ```
 
 ---
@@ -355,7 +367,7 @@ feat!: redesign authentication API
 
 ## Config File
 
-`contrib setup` writes `.git/contribute-now/config.json` by default. If a legacy `.contributerc.json` already exists, it remains the active source until you migrate or remove it:
+`cn setup` writes `.git/contribute-now/config.json` by default. If a legacy `.contributerc.json` already exists, it remains the active source until you migrate or remove it:
 
 ```json
 {
@@ -370,7 +382,7 @@ feat!: redesign authentication API
 }
 ```
 
-Use `contrib config --edit` to change these values later without rerunning the full setup flow. If you are still on the legacy `.contributerc.json`, keep that file ignored until you migrate away from it.
+Use `cn config --edit` to change these values later without rerunning the full setup flow. If you are still on the legacy `.contributerc.json`, keep that file ignored until you migrate away from it.
 
 ---
 
@@ -386,6 +398,8 @@ bun test        # run tests
 bun run lint    # check code quality
 ```
 
+The CLI is Bun-first end to end: local development, tests, packaged runtime, and one-off execution all assume Bun.
+
 ## 🎯 Contributing
 
 Contributions are welcome, create a pull request to this repo and I will review your code. Please consider to submit your pull request to the `dev` branch. Thank you!
@@ -418,7 +432,7 @@ This project is licensed under [GNU General Public License v3.0](https://opensou
 
 This project is created by **[Waren Gonzaga](https://github.com/warengonzaga)**, with the help of awesome [contributors](https://github.com/warengonzaga/contribute-now/graphs/contributors).
 
-[![contributors](https://contrib.rocks/image?repo=warengonzaga/contribute-now)](https://github.com/warengonzaga/contribute-now/graphs/contributors)
+[![contributors](https://cn.rocks/image?repo=warengonzaga/contribute-now)](https://github.com/warengonzaga/contribute-now/graphs/contributors)
 
 ---