ccski 1.0.3 → 2.0.0

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.
package/README.md CHANGED
@@ -1,22 +1,32 @@
1
1
  # ccski – Claude Code Skills Manager
2
2
 
3
- ccski is a CLI + MCP server that lets any AI coding assistant discover, install, enable/disable, and serve Claude Code-compatible skills. It is purpose-built to be lightweight, type-safe, and easy to embed in your editor or agent toolchain.
3
+ ccski is a CLI + MCP server to discover, install, enable/disable, and serve Claude Code-compatible skills. This README covers install and usage. For architecture and UX philosophy, see `SPEC.md`.
4
4
 
5
- ## 1) Positioning & MCP quick start
5
+ ## Install
6
6
 
7
- - **What it is**: a thin, batteries-included manager for SKILL.md–based skill packs (local folders, git repos, plugin marketplaces).
8
- - **Who it’s for**: humans running CLI workflows and agents connecting over MCP.
7
+ Requires Node.js >= 20.
9
8
 
10
- ### Start MCP in one line
9
+ ```bash
10
+ # run directly
11
+ npx ccski --help
12
+
13
+ # or install locally
14
+ pnpm install ccski
15
+ ccski --help
16
+ ```
17
+
18
+ ## Quick start
19
+
20
+ ### Run MCP server
11
21
 
12
22
  ```bash
13
23
  npx ccski mcp
14
24
  ```
15
25
 
16
- Common MCP registrations:
26
+ - Add extra skill roots: `npx ccski mcp --skill-dir /extra/skills`
27
+ - Disable auto refresh: `npx ccski mcp --no-refresh`
17
28
 
18
- - **Codex CLI**: `codex mcp add skills -- npx ccski mcp`
19
- - **Cursor / Windsurf / VS Code MCP plugins** (config excerpt):
29
+ MCP plugin config example (Codex/Cursor/Windsurf/VS Code):
20
30
 
21
31
  ```json
22
32
  {
@@ -29,70 +39,44 @@ Common MCP registrations:
29
39
  }
30
40
  ```
31
41
 
32
- Run with `--skill-dir` to add extra roots, or `--no-refresh` to disable live reload.
33
-
34
- ## 2) Core CLI surface (human-friendly)
35
-
36
- | Command | Purpose |
37
- | ------------------------------------------- | ---------------------------------------------------------------------------------------- |
38
- | `ccski list` | Show discovered skills (projects, home, plugin marketplace) with status badges |
39
- | `ccski info <name>` | Inspect metadata and preview content |
40
- | `ccski install <source> [-i\|--all\|--use]` | Install skills from git/dir/marketplace; interactive picker shows final one-shot command |
41
- | `ccski enable [names...] [-i\|--all]` | Restore `.SKILL.md` → `SKILL.md`; interactive defaults **unchecked** |
42
- | `ccski disable [names...] [-i\|--all]` | Disable skills by flipping to `.SKILL.md` |
43
- | `ccski mcp` | Start MCP server (stdio/http/sse) |
44
- | `ccski validate <path>` | Validate SKILL.md or directory structure |
45
-
46
- Interactive pickers across install/enable/disable share the same layout, colors, and live “Command:” preview so you can copy/paste the equivalent non-interactive invocation.
47
-
48
- ## 3) Thanks & lineage
49
-
50
- - **openskills** — established the SKILL.md authoring pattern; we align with that spec for compatibility.
51
- - **universal-skills** — offers a curated, ready-to-use skill set; ccski focuses on management and transport, not bundling content.
42
+ ### Core CLI commands
52
43
 
53
- Key differences and what we fused:
54
- - We blend **universal-skills’ MCP-first philosophy** with **openskills’ CLI ergonomics** so the same tool serves both agents and humans.
55
- - ccski uniquely **scans skills shipped inside Claude Code plugins**, which universal-skills and openskills don’t cover.
56
- - The `install` command accepts flexible sources (git URLs, marketplace, SKILL.md paths) and `-i` provides an interactive picker with a live one-shot command preview.
44
+ | Command | Purpose |
45
+ | --- | --- |
46
+ | `ccski list` | List discovered skills (project, user, plugin) |
47
+ | `ccski info <name>` | Show metadata and content preview |
48
+ | `ccski install <source> [-i|--all|--path]` | Install from git/dir/marketplace/SKILL.md; interactive picker available |
49
+ | `ccski enable [names...] [-i|--all]` | Enable skills (`.SKILL.md` -> `SKILL.md`) |
50
+ | `ccski disable [names...] [-i|--all]` | Disable skills (`SKILL.md` -> `.SKILL.md`) |
51
+ | `ccski validate <path>` | Validate SKILL.md or skill directory |
52
+ | `ccski mcp` | Start MCP server (stdio/http/sse) |
57
53
 
58
- Bottom line: ccski is a manager/server (no baked-in corpus), MCP-first, multi-root-aware, with a friendlier install/enable/disable workflow.
54
+ ### Install examples
59
55
 
60
- ## 4) Contributing & architecture at a glance
56
+ - Git repo (auto-detect marketplace):
57
+ `ccski install https://github.com/wshobson/agents`
58
+ - Specific branch or path:
59
+ `ccski install https://github.com/wshobson/agents/tree/main --branch main`
60
+ `ccski install https://github.com/wshobson/agents --path skills/foo/SKILL.md`
61
+ - Local directory or single file:
62
+ `ccski install /path/to/skills --mode file`
63
+ `ccski install ./plugins/foo/SKILL.md`
64
+ - Overwrite existing skill: add `--force` (or `--override`).
61
65
 
62
- ### Fast start
63
-
64
- - `pnpm install`
65
- - `pnpm test` (Vitest)
66
- - `pnpm ts` (type-check)
67
- - `pnpm build` (tsdown)
68
-
69
- ### Architecture map
70
-
71
- - Entry: `src/cli.ts` (yargs CLI, shared color flags)
72
- - Commands: `src/cli/commands/*.ts`
73
- - Interactive UI: `src/cli/prompts/multiSelect.ts` (shared checkbox with live command preview)
74
- - Formatting: `src/utils/format.ts` (tone helpers; avoid ad-hoc colors)
75
- - Skill core: `src/core/*` (discovery, registry, parsing)
76
- - Tests: `tests/*.test.ts` (Vitest + bun runtime for CLI e2e)
77
-
78
- Suggested reading order: `src/utils/format.ts` → `src/cli/prompts/multiSelect.ts` → command files (install, toggle) → `src/core/registry.ts`.
79
-
80
- ### Code style highlights
81
-
82
- - TypeScript strict; no `any`/`as any`/`@ts-nocheck` unless unavoidable for third-party types.
83
- - Keep CLI colors via `tone/heading/warn/info/success/error`; don’t hardcode colorette directly.
84
- - Prefer small files (<200 lines) or refactor into folders when complexity grows.
85
- - Tests: Vitest with jsdom where needed; integration tests exercise CLI via bun runner.
86
- - Package manager: pnpm; scripts live in `package.json`.
87
-
88
- ### Development scripts
66
+ ### Enable/disable
89
67
 
90
68
  ```bash
91
- pnpm install # deps
92
- pnpm test # full test suite
93
- pnpm ts # type check
94
- pnpm build # bundle with tsdown
95
- pnpm fmt # prettier + organize imports + tailwind plugin
69
+ # Enable via interactive picker
70
+ ccski enable -i
71
+
72
+ # Disable all enabled skills
73
+ ccski disable --all
96
74
  ```
97
75
 
98
- Happy hacking — PRs welcome!
76
+ ## More
77
+
78
+ - Claude users: prefer `ccski mcp --exclude=claude` to avoid echoing built-in Claude skills.
79
+ - Codex users: prefer `ccski mcp --exclude=codex` when avoid echoing built-in Codex skills.
80
+ - All commands support `--json` for scripting.
81
+ - Use `--no-color` to disable colors or `--color` to force them.
82
+ - Read `SPEC.md` for deep technical details and design philosophy.
@@ -0,0 +1,34 @@
1
+ import { createRequire } from "node:module";
2
+
3
+ //#region rolldown:runtime
4
+ var __create = Object.create;
5
+ var __defProp = Object.defineProperty;
6
+ var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
7
+ var __getOwnPropNames = Object.getOwnPropertyNames;
8
+ var __getProtoOf = Object.getPrototypeOf;
9
+ var __hasOwnProp = Object.prototype.hasOwnProperty;
10
+ var __commonJS = (cb, mod) => function() {
11
+ return mod || (0, cb[__getOwnPropNames(cb)[0]])((mod = { exports: {} }).exports, mod), mod.exports;
12
+ };
13
+ var __copyProps = (to, from, except, desc) => {
14
+ if (from && typeof from === "object" || typeof from === "function") {
15
+ for (var keys = __getOwnPropNames(from), i = 0, n = keys.length, key; i < n; i++) {
16
+ key = keys[i];
17
+ if (!__hasOwnProp.call(to, key) && key !== except) {
18
+ __defProp(to, key, {
19
+ get: ((k) => from[k]).bind(null, key),
20
+ enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable
21
+ });
22
+ }
23
+ }
24
+ }
25
+ return to;
26
+ };
27
+ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", {
28
+ value: mod,
29
+ enumerable: true
30
+ }) : target, mod));
31
+ var __require = /* @__PURE__ */ createRequire(import.meta.url);
32
+
33
+ //#endregion
34
+ export { __require as n, __toESM as r, __commonJS as t };