claudekit-cli 3.35.0-dev.6 → 3.35.0-dev.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/README.md +20 -1
  2. package/dist/index.js +440 -3
  3. package/package.json +1 -1
package/README.md CHANGED
@@ -9,7 +9,7 @@ Command-line tool and web dashboard for managing ClaudeKit projects.
9
9
  ClaudeKit Config UI (`ck`) provides both CLI and web dashboard for managing ClaudeKit projects. Built with Bun, TypeScript, and React, enables fast, secure project setup and comprehensive configuration management.
10
10
 
11
11
  **Key Features:**
12
- - **CLI Commands (10)**: new, init, config, projects, skill, doctor, version, update, uninstall, easter-egg
12
+ - **CLI Commands (14)**: new, init, config, projects, setup, skills, agents, commands, port, doctor, versions, update, uninstall, easter-egg
13
13
  - **Web Dashboard**: Interactive React UI via `ck config ui` for configuration and project management
14
14
  - **Projects Registry**: Centralized registry at `~/.claudekit/projects.json` with file locking
15
15
  - **Skill Installation**: Install ClaudeKit skills to other coding agents (Cursor, Codex, etc.)
@@ -78,6 +78,23 @@ ck --version
78
78
 
79
79
  ## Usage
80
80
 
81
+ ### Discoverability Quick Start
82
+
83
+ ```bash
84
+ # Top-level command discovery
85
+ ck --help
86
+
87
+ # Open config dashboard immediately
88
+ ck config
89
+
90
+ # Command-level help (recommended)
91
+ ck config --help
92
+ ck skills --help
93
+ ck agents --help
94
+ ck commands --help
95
+ ck port --help
96
+ ```
97
+
81
98
  ### Create New Project
82
99
 
83
100
  ```bash
@@ -301,6 +318,8 @@ ck -h
301
318
  # Command-specific help
302
319
  ck new --help
303
320
  ck init --help
321
+ ck config --help
322
+ ck skills --help
304
323
  ck versions --help
305
324
  ```
306
325
 
package/dist/index.js CHANGED
@@ -48830,7 +48830,7 @@ var package_default;
48830
48830
  var init_package = __esm(() => {
48831
48831
  package_default = {
48832
48832
  name: "claudekit-cli",
48833
- version: "3.35.0-dev.6",
48833
+ version: "3.35.0-dev.7",
48834
48834
  description: "CLI tool for bootstrapping and updating ClaudeKit projects",
48835
48835
  type: "module",
48836
48836
  repository: {
@@ -61316,6 +61316,425 @@ var init_skills_command_help = __esm(() => {
61316
61316
  };
61317
61317
  });
61318
61318
 
61319
+ // src/domains/help/commands/config-command-help.ts
61320
+ var configCommandHelp;
61321
+ var init_config_command_help = __esm(() => {
61322
+ configCommandHelp = {
61323
+ name: "config",
61324
+ description: "Manage ClaudeKit configuration and launch the config dashboard",
61325
+ usage: "ck config [action] [key] [value] [options]",
61326
+ examples: [
61327
+ {
61328
+ command: "ck config",
61329
+ description: "Launch the web dashboard (same as 'ck config ui')"
61330
+ },
61331
+ {
61332
+ command: "ck config set defaults.kit engineer",
61333
+ description: "Set a config value from the CLI"
61334
+ }
61335
+ ],
61336
+ optionGroups: [
61337
+ {
61338
+ title: "Actions",
61339
+ options: [
61340
+ {
61341
+ flags: "ui",
61342
+ description: "Launch config dashboard (default action when omitted)"
61343
+ },
61344
+ {
61345
+ flags: "get <key>",
61346
+ description: "Read a config value"
61347
+ },
61348
+ {
61349
+ flags: "set <key> <value>",
61350
+ description: "Write a config value"
61351
+ },
61352
+ {
61353
+ flags: "show",
61354
+ description: "Print merged config"
61355
+ }
61356
+ ]
61357
+ },
61358
+ {
61359
+ title: "Scope Options",
61360
+ options: [
61361
+ {
61362
+ flags: "-g, --global",
61363
+ description: "Use global config (~/.claudekit/config.json)"
61364
+ },
61365
+ {
61366
+ flags: "-l, --local",
61367
+ description: "Use local config (.claude/.ck.json)"
61368
+ }
61369
+ ]
61370
+ },
61371
+ {
61372
+ title: "Dashboard Options",
61373
+ options: [
61374
+ {
61375
+ flags: "--port <port>",
61376
+ description: "Port for dashboard server"
61377
+ },
61378
+ {
61379
+ flags: "--no-open",
61380
+ description: "Do not auto-open browser when launching dashboard"
61381
+ },
61382
+ {
61383
+ flags: "--dev",
61384
+ description: "Run dashboard in development mode with HMR"
61385
+ }
61386
+ ]
61387
+ },
61388
+ {
61389
+ title: "Output Options",
61390
+ options: [
61391
+ {
61392
+ flags: "--json",
61393
+ description: "Output machine-readable JSON for CLI actions"
61394
+ }
61395
+ ]
61396
+ }
61397
+ ],
61398
+ sections: [
61399
+ {
61400
+ title: "Notes",
61401
+ content: "Run 'ck config --help' to see both CLI actions and dashboard flags. Running bare 'ck config' opens the dashboard directly."
61402
+ }
61403
+ ]
61404
+ };
61405
+ });
61406
+
61407
+ // src/domains/help/commands/projects-command-help.ts
61408
+ var projectsCommandHelp;
61409
+ var init_projects_command_help = __esm(() => {
61410
+ projectsCommandHelp = {
61411
+ name: "projects",
61412
+ description: "Manage local ClaudeKit project registry entries",
61413
+ usage: "ck projects <subcommand> [options]",
61414
+ examples: [
61415
+ {
61416
+ command: "ck projects list --pinned",
61417
+ description: "Show only pinned projects"
61418
+ },
61419
+ {
61420
+ command: "ck projects add . --alias engine --pinned",
61421
+ description: "Add current directory with an alias and pin it"
61422
+ }
61423
+ ],
61424
+ optionGroups: [
61425
+ {
61426
+ title: "Subcommands",
61427
+ options: [
61428
+ {
61429
+ flags: "list | ls",
61430
+ description: "List projects in registry"
61431
+ },
61432
+ {
61433
+ flags: "add <path>",
61434
+ description: "Add project path to registry"
61435
+ },
61436
+ {
61437
+ flags: "remove [alias] | rm [alias]",
61438
+ description: "Remove project by alias or ID"
61439
+ }
61440
+ ]
61441
+ },
61442
+ {
61443
+ title: "List Options",
61444
+ options: [
61445
+ {
61446
+ flags: "--json",
61447
+ description: "Output in JSON format"
61448
+ },
61449
+ {
61450
+ flags: "--pinned",
61451
+ description: "Filter to pinned projects only"
61452
+ }
61453
+ ]
61454
+ },
61455
+ {
61456
+ title: "Add/Remove Options",
61457
+ options: [
61458
+ {
61459
+ flags: "--alias <alias>",
61460
+ description: "Custom alias for project (add)"
61461
+ },
61462
+ {
61463
+ flags: "--tags <tags>",
61464
+ description: "Comma-separated tags (add)"
61465
+ },
61466
+ {
61467
+ flags: "--id <id>",
61468
+ description: "Remove by project ID (remove)"
61469
+ }
61470
+ ]
61471
+ }
61472
+ ]
61473
+ };
61474
+ });
61475
+
61476
+ // src/domains/help/commands/setup-command-help.ts
61477
+ var setupCommandHelp;
61478
+ var init_setup_command_help = __esm(() => {
61479
+ setupCommandHelp = {
61480
+ name: "setup",
61481
+ description: "Run guided setup for API keys and optional packages",
61482
+ usage: "ck setup [options]",
61483
+ examples: [
61484
+ {
61485
+ command: "ck setup",
61486
+ description: "Run setup wizard in current project"
61487
+ },
61488
+ {
61489
+ command: "ck setup --global --skip-packages",
61490
+ description: "Configure global setup without package installation"
61491
+ }
61492
+ ],
61493
+ optionGroups: [
61494
+ {
61495
+ title: "Options",
61496
+ options: [
61497
+ {
61498
+ flags: "--global",
61499
+ description: "Configure in global Claude directory (~/.claude/)"
61500
+ },
61501
+ {
61502
+ flags: "--skip-packages",
61503
+ description: "Skip optional package installation"
61504
+ },
61505
+ {
61506
+ flags: "--dir <dir>",
61507
+ description: "Target directory for setup",
61508
+ defaultValue: "current directory"
61509
+ }
61510
+ ]
61511
+ }
61512
+ ]
61513
+ };
61514
+ });
61515
+
61516
+ // src/domains/help/commands/agents-command-help.ts
61517
+ var agentsCommandHelp;
61518
+ var init_agents_command_help = __esm(() => {
61519
+ agentsCommandHelp = {
61520
+ name: "agents",
61521
+ description: "Install, uninstall, and manage Claude Code agents across providers",
61522
+ usage: "ck agents [options]",
61523
+ examples: [
61524
+ {
61525
+ command: "ck agents --name maintainer --agent codex",
61526
+ description: "Install one agent to Codex"
61527
+ },
61528
+ {
61529
+ command: "ck agents --list --installed",
61530
+ description: "Show installed agents and locations"
61531
+ }
61532
+ ],
61533
+ optionGroups: [
61534
+ {
61535
+ title: "Mode Options",
61536
+ options: [
61537
+ {
61538
+ flags: "-l, --list",
61539
+ description: "List available agents from source"
61540
+ },
61541
+ {
61542
+ flags: "--installed",
61543
+ description: "When used with --list, show installed agents instead"
61544
+ },
61545
+ {
61546
+ flags: "-u, --uninstall",
61547
+ description: "Uninstall agent(s) from providers"
61548
+ },
61549
+ {
61550
+ flags: "--sync",
61551
+ description: "Sync registry with filesystem (clean orphaned entries)"
61552
+ }
61553
+ ]
61554
+ },
61555
+ {
61556
+ title: "Installation Options",
61557
+ options: [
61558
+ {
61559
+ flags: "-n, --name <agent>",
61560
+ description: "Agent name to install or uninstall"
61561
+ },
61562
+ {
61563
+ flags: "-a, --agent <provider>",
61564
+ description: "Target provider(s), can be specified multiple times"
61565
+ },
61566
+ {
61567
+ flags: "-g, --global",
61568
+ description: "Install globally instead of project-level"
61569
+ },
61570
+ {
61571
+ flags: "--all",
61572
+ description: "Install to all supported providers"
61573
+ },
61574
+ {
61575
+ flags: "-y, --yes",
61576
+ description: "Skip confirmation prompts"
61577
+ }
61578
+ ]
61579
+ },
61580
+ {
61581
+ title: "Uninstall Options",
61582
+ options: [
61583
+ {
61584
+ flags: "--force",
61585
+ description: "Force uninstall even if not tracked in registry"
61586
+ }
61587
+ ]
61588
+ }
61589
+ ]
61590
+ };
61591
+ });
61592
+
61593
+ // src/domains/help/commands/commands-command-help.ts
61594
+ var commandsCommandHelp;
61595
+ var init_commands_command_help = __esm(() => {
61596
+ commandsCommandHelp = {
61597
+ name: "commands",
61598
+ description: "Install, uninstall, and manage Claude commands across providers",
61599
+ usage: "ck commands [options]",
61600
+ examples: [
61601
+ {
61602
+ command: "ck commands --name plan --agent codex",
61603
+ description: "Install one slash command to Codex"
61604
+ },
61605
+ {
61606
+ command: "ck commands --list",
61607
+ description: "List available commands from source"
61608
+ }
61609
+ ],
61610
+ optionGroups: [
61611
+ {
61612
+ title: "Mode Options",
61613
+ options: [
61614
+ {
61615
+ flags: "-l, --list",
61616
+ description: "List available commands from source"
61617
+ },
61618
+ {
61619
+ flags: "--installed",
61620
+ description: "When used with --list, show installed commands instead"
61621
+ },
61622
+ {
61623
+ flags: "-u, --uninstall",
61624
+ description: "Uninstall command(s) from providers"
61625
+ },
61626
+ {
61627
+ flags: "--sync",
61628
+ description: "Sync registry with filesystem (clean orphaned entries)"
61629
+ }
61630
+ ]
61631
+ },
61632
+ {
61633
+ title: "Installation Options",
61634
+ options: [
61635
+ {
61636
+ flags: "-n, --name <command>",
61637
+ description: "Command name to install or uninstall"
61638
+ },
61639
+ {
61640
+ flags: "-a, --agent <provider>",
61641
+ description: "Target provider(s), can be specified multiple times"
61642
+ },
61643
+ {
61644
+ flags: "-g, --global",
61645
+ description: "Install globally instead of project-level"
61646
+ },
61647
+ {
61648
+ flags: "--all",
61649
+ description: "Install to all supported providers"
61650
+ },
61651
+ {
61652
+ flags: "-y, --yes",
61653
+ description: "Skip confirmation prompts"
61654
+ }
61655
+ ]
61656
+ },
61657
+ {
61658
+ title: "Uninstall Options",
61659
+ options: [
61660
+ {
61661
+ flags: "--force",
61662
+ description: "Force uninstall even if not tracked in registry"
61663
+ }
61664
+ ]
61665
+ }
61666
+ ]
61667
+ };
61668
+ });
61669
+
61670
+ // src/domains/help/commands/port-command-help.ts
61671
+ var portCommandHelp;
61672
+ var init_port_command_help = __esm(() => {
61673
+ portCommandHelp = {
61674
+ name: "port",
61675
+ description: "Port agents, commands, skills, config, and rules to other providers",
61676
+ usage: "ck port [options]",
61677
+ examples: [
61678
+ {
61679
+ command: "ck port --agent codex --agent opencode",
61680
+ description: "Port all supported content to selected providers"
61681
+ },
61682
+ {
61683
+ command: "ck port --config --source ./CLAUDE.md",
61684
+ description: "Port only config from a specific source file"
61685
+ }
61686
+ ],
61687
+ optionGroups: [
61688
+ {
61689
+ title: "Target Options",
61690
+ options: [
61691
+ {
61692
+ flags: "-a, --agent <provider>",
61693
+ description: "Target provider(s), can be specified multiple times"
61694
+ },
61695
+ {
61696
+ flags: "--all",
61697
+ description: "Port to all supported providers"
61698
+ },
61699
+ {
61700
+ flags: "-g, --global",
61701
+ description: "Install globally instead of project-level"
61702
+ },
61703
+ {
61704
+ flags: "-y, --yes",
61705
+ description: "Skip confirmation prompts"
61706
+ }
61707
+ ]
61708
+ },
61709
+ {
61710
+ title: "Content Selection",
61711
+ options: [
61712
+ {
61713
+ flags: "--config",
61714
+ description: "Port CLAUDE.md config only"
61715
+ },
61716
+ {
61717
+ flags: "--rules",
61718
+ description: "Port .claude/rules only"
61719
+ },
61720
+ {
61721
+ flags: "--skip-config",
61722
+ description: "Skip config porting"
61723
+ },
61724
+ {
61725
+ flags: "--skip-rules",
61726
+ description: "Skip rules porting"
61727
+ },
61728
+ {
61729
+ flags: "--source <path>",
61730
+ description: "Custom CLAUDE.md source path"
61731
+ }
61732
+ ]
61733
+ }
61734
+ ]
61735
+ };
61736
+ });
61737
+
61319
61738
  // src/domains/help/commands/index.ts
61320
61739
  var init_commands2 = __esm(() => {
61321
61740
  init_new_command_help();
@@ -61325,6 +61744,12 @@ var init_commands2 = __esm(() => {
61325
61744
  init_update_command_help();
61326
61745
  init_versions_command_help();
61327
61746
  init_skills_command_help();
61747
+ init_config_command_help();
61748
+ init_projects_command_help();
61749
+ init_setup_command_help();
61750
+ init_agents_command_help();
61751
+ init_commands_command_help();
61752
+ init_port_command_help();
61328
61753
  init_common_options();
61329
61754
  });
61330
61755
 
@@ -61339,11 +61764,17 @@ var init_help_commands = __esm(() => {
61339
61764
  HELP_REGISTRY = {
61340
61765
  new: newCommandHelp,
61341
61766
  init: initCommandHelp,
61767
+ config: configCommandHelp,
61768
+ projects: projectsCommandHelp,
61769
+ setup: setupCommandHelp,
61342
61770
  update: updateCommandHelp,
61343
61771
  versions: versionsCommandHelp,
61344
61772
  doctor: doctorCommandHelp,
61345
61773
  uninstall: uninstallCommandHelp,
61346
- skills: skillsCommandHelp
61774
+ skills: skillsCommandHelp,
61775
+ agents: agentsCommandHelp,
61776
+ commands: commandsCommandHelp,
61777
+ port: portCommandHelp
61347
61778
  };
61348
61779
  });
61349
61780
 
@@ -61649,6 +62080,12 @@ function renderGlobalHelp(commands, options2 = DEFAULT_HELP_OPTIONS) {
61649
62080
  lines.push(`${cmdPart}${descPart}`);
61650
62081
  }
61651
62082
  lines.push("");
62083
+ lines.push(theme.heading("Quick Start:"));
62084
+ lines.push(` ${padEnd(theme.example("ck config"), 24)}${theme.description("Open the config dashboard")}`);
62085
+ lines.push(` ${padEnd(theme.example("ck config --help"), 24)}${theme.description("See config actions and dashboard flags")}`);
62086
+ lines.push(` ${padEnd(theme.example("ck skills --help"), 24)}${theme.description("Discover skill installation workflows")}`);
62087
+ lines.push(` ${padEnd(theme.example("ck port --help"), 24)}${theme.description("Migrate agents/commands/skills across providers")}`);
62088
+ lines.push("");
61652
62089
  lines.push(theme.heading("Global Options:"));
61653
62090
  lines.push(` ${padEnd(theme.flag("--verbose"), 20)}${theme.description("Enable verbose logging")}`);
61654
62091
  lines.push(` ${padEnd(theme.flag("--log-file <path>"), 20)}${theme.description("Write logs to file")}`);
@@ -61660,7 +62097,7 @@ function renderGlobalHelp(commands, options2 = DEFAULT_HELP_OPTIONS) {
61660
62097
  lines.push(` ${padEnd(theme.flag("GITHUB_TOKEN"), 20)}${theme.description("Environment variable for Classic PAT")}`);
61661
62098
  lines.push(` ${padEnd(theme.flag("gh auth login"), 20)}${theme.description("GitHub CLI authentication (default)")}`);
61662
62099
  lines.push("");
61663
- lines.push(theme.muted("Run 'ck <command> --help' for detailed command information"));
62100
+ lines.push(theme.muted("Run 'ck <command> --help' for details. Start with 'ck skills --help' and 'ck config --help'."));
61664
62101
  return lines.filter((s) => s !== undefined).join(`
61665
62102
  `);
61666
62103
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "claudekit-cli",
3
- "version": "3.35.0-dev.6",
3
+ "version": "3.35.0-dev.7",
4
4
  "description": "CLI tool for bootstrapping and updating ClaudeKit projects",
5
5
  "type": "module",
6
6
  "repository": {