@forceuser/git-profile-switcher 0.1.6 → 0.1.7

package/README.md

@@ -1,96 +1,177 @@
 # Git Profile Switcher
 
-`gip` is a small local-first CLI/TUI for managing multiple Git identities and applying
-them automatically per directory with Git `includeIf`.
+`gip` helps you use the right Git identity in the right directory.
 
-It keeps profile metadata in app data, writes generated profile config files, and manages
-one clearly marked block in your global `~/.gitconfig`.
+It stores named profiles, writes Git `includeIf` rules for directory-based switching,
+and can show the active profile in your shell prompt.
 
-## Quick Start
+## Install
 
 ```bash
-npm test
-npm run dev -- profile:add
-npm run dev -- profile:add work --user-name "Work Name" --user-email work@example.com
-npm run dev -- use
-npm run dev -- use work
-npm run dev -- prompt
-npm run dev -- prompt --format profile
+npm install -g @forceuser/git-profile-switcher
 ```
 
-## Common Commands
+After installation, the CLI is available as both:
 
 ```bash
-gip profile:add
+gip --help
+git-profile-switcher --help
+```
+
+## Quick Start
+
+Create your profiles:
+
+```bash
+gip profile:add personal
 gip profile:add work --user-name "Work Name" --user-email work@example.com
-gip profile:list
-gip profile:color work cyan
-gip use
+```
+
+Use a profile in the current directory:
+
+```bash
+cd ~/Projects/work-app
 gip use work
-gip use work --global
-gip now work
-gip now --clear
+```
+
+From now on, Git uses that profile in this directory and its Git repositories.
+
+Check what Git identity is active:
+
+```bash
+gip doctor
+```
+
+## Daily Use
+
+Pick from your saved profiles:
+
+```bash
+gip use
+```
+
+Set a global fallback identity:
+
+```bash
+gip use personal --global
+```
+
+Clear the current directory rule:
+
+```bash
 gip clear
+```
+
+Clear the global fallback identity:
+
+```bash
 gip clear --global
-gip rule:add ~/Developer/Work
-gip rule:add work ~/Developer/Work
-gip rule:list
-gip apply
-gip doctor
-gip prompt --format profile
+```
+
+Open the terminal UI:
+
+```bash
 gip tui
+```
+
+## Session-Only Identity
+
+Use `now` when you want a profile only in the current terminal session:
+
+```bash
 gip install:shell zsh
-gip install:prompt zsh
-gip install:prompt zsh --format profile
+source ~/.zshrc
+
+gip now work
+gip now --clear
 ```
 
-## Development
+Without shell integration, use:
 
 ```bash
-npm install
-npm run verify
-npm run verify:publish
+eval "$(gip now work --exports)"
 ```
 
-`npm install` runs the local Husky setup when the checkout has a `.git` directory.
-Pre-commit runs `lint-staged`; pre-push runs `npm run verify`.
+## Shell Prompt
+
+Install prompt integration to show the active profile in your prompt:
 
-## Publication
+```bash
+gip install:prompt zsh
+source ~/.zshrc
+```
 
-The package builds to `dist/` and publishes only `bin/`, `dist/runtime/`, `README.md`,
-and `package.json`.
+Choose prompt colors per profile:
 
 ```bash
-npm run build
-npm run smoke:package
-npm run verify:publish
+gip profile:color work cyan
 ```
 
-GitHub Actions publishes to the public npm registry from SemVer tags or GitHub releases.
-See [Release With GitHub Actions](./docs/operations/release-with-github-actions.md).
+Install completion, session wrapper, and prompt integration together:
 
-## Shell Prompt
+```bash
+gip install:all zsh
+```
+
+Supported shells: `zsh`, `bash`, and `fish`.
+
+## Move To A New Machine
 
-After installing prompt integration, your shell prompt can show the effective Git identity
-for the current directory. The prompt command itself is intentionally plain:
+Export profiles:
 
 ```bash
-gip prompt
-gip prompt --json
+gip export
 ```
 
-Use `gip profile:color` to color the managed profile segment in installed shell prompts.
+Import profiles on another machine:
 
-## Storage
+```bash
+gip import
+```
 
-Default app data lives at:
+By default, both commands use:
+
+```text
+~/gip-profiles.json
+```
+
+Directory rules are machine-specific, so `gip` skips them by default. Include them only
+when you explicitly want to migrate the same directory mappings:
+
+```bash
+gip export --rules
+gip import --rules
+```
+
+## Where Data Lives
+
+Profile metadata:
 
 ```text
 ~/.config/git-profile-switcher/
 ```
 
-Generated Git config snippets live under:
+Generated Git config snippets:
 
 ```text
 ~/.config/git-profile-switcher/gitconfigs/
 ```
+
+`gip` manages one marked block in your global Git config and leaves unrelated content
+alone.
+
+## Useful Commands
+
+```bash
+gip profile:list
+gip profile:remove work
+gip rule:list
+gip rule:add work ~/Projects/work-app
+gip rule:remove <rule-id>
+gip paths
+gip prompt
+gip help <command>
+```
+
+For development and release notes, see
+[Development](https://github.com/forceuser/git-profile-switcher/blob/main/docs/development.md).

package/dist/runtime/app/index.js

@@ -241,7 +241,7 @@ export async function main(args = process.argv.slice(2)) {
     }
     if (command === "export") {
         const data = await repository.read();
-        const exportData = hasFlag(parsed, "profiles-only") ? { ...data, rules: [] } : data;
+        const exportData = hasFlag(parsed, "rules") ? data : { ...data, rules: [] };
         const bundle = createProfileExportBundle(exportData);
         const outputPath = getStringFlag(parsed, "output") ??
             parsed.positionals[0] ??
@@ -266,7 +266,7 @@ export async function main(args = process.argv.slice(2)) {
         }
         const resolvedInputPath = resolve(inputPath);
         const incoming = parseProfileImportBundle(JSON.parse(await readFile(resolvedInputPath, "utf8")));
-        const importData = hasFlag(parsed, "profiles-only") ? { ...incoming, rules: [] } : incoming;
+        const importData = hasFlag(parsed, "rules") ? incoming : { ...incoming, rules: [] };
         const current = await repository.read();
         const next = hasFlag(parsed, "replace")
             ? importData

package/dist/runtime/cli/help.js

@@ -102,25 +102,25 @@ export const COMMANDS = [
     },
     {
         name: "export",
-        summary: "Export profiles and directory rules for migration.",
-        usage: "gip export [--output <path>] [--profiles-only]\n  gip export <path>",
-        completionFlags: ["--output", "--profiles-only", "--help"],
+        summary: "Export profiles for migration, optionally with directory rules.",
+        usage: "gip export [--output <path>] [--rules]\n  gip export <path>",
+        completionFlags: ["--output", "--rules", "--help"],
         examples: [
             "gip export",
-            "gip export --profiles-only",
+            "gip export --rules",
             "gip export --output ./gip-profiles.backup.json",
             "gip export ./gip.json",
         ],
     },
     {
         name: "import",
-        summary: "Import profiles and directory rules from a migration file.",
-        usage: "gip import [--input <path>] [--replace] [--profiles-only] [--no-apply]\n  gip import <path>",
-        completionFlags: ["--input", "--replace", "--profiles-only", "--no-apply", "--help"],
+        summary: "Import profiles from a migration file, optionally with directory rules.",
+        usage: "gip import [--input <path>] [--replace] [--rules] [--no-apply]\n  gip import <path>",
+        completionFlags: ["--input", "--replace", "--rules", "--no-apply", "--help"],
         examples: [
             "gip import",
             "gip import --input ./gip-profiles.backup.json",
-            "gip import --profiles-only",
+            "gip import --rules",
             "gip import ./gip.json --replace",
             "gip import ./gip.json --no-apply",
         ],

package/dist/runtime/tui/index.js

@@ -131,8 +131,8 @@ async function diagnosticsMenu(context) {
 }
 async function migrationMenu(context) {
     return await runMenu(context, "Import and export", [
-        { label: "Export profiles and rules", run: () => exportProfiles(context) },
-        { label: "Import profiles and rules", run: () => importProfiles(context) },
+        { label: "Export profiles", run: () => exportProfiles(context) },
+        { label: "Import profiles", run: () => importProfiles(context) },
         { label: "Back", run: async () => "back" },
     ]);
 }
@@ -472,8 +472,8 @@ async function selectPromptFormat(context) {
 }
 async function selectTransferScope(context, prompt) {
     const scopes = [
-        "profiles-and-rules",
         "profiles-only",
+        "profiles-and-rules",
     ];
     const scope = await context.prompts.selectOne({
         prompt,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@forceuser/git-profile-switcher",
-  "version": "0.1.6",
+  "version": "0.1.7",
   "private": false,
   "description": "CLI and TUI for automatic per-directory Git user identity switching.",
   "keywords": [