@skillkit/cli 1.3.1 → 1.4.0

package/README.md

@@ -1,39 +1,192 @@
 # @skillkit/cli
 
-CLI commands for SkillKit - install, manage, and sync skills across AI agents.
+[![npm version](https://img.shields.io/npm/v/@skillkit/cli.svg)](https://www.npmjs.com/package/@skillkit/cli)
+[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+
+**Command-line interface for SkillKit** - install, manage, translate, and sync skills across 17 AI coding agents.
 
 ## Installation
 
 ```bash
-npm install @skillkit/cli
+npm install -g @skillkit/cli
+# or
+npm install -g skillkit  # includes CLI
+```
+
+## Quick Start
+
+```bash
+# Get skill recommendations for your project
+skillkit recommend
+
+# Install skills from GitHub
+skillkit install anthropics/skills
+
+# Translate skills between agents
+skillkit translate my-skill --to cursor
+
+# Launch interactive TUI
+skillkit ui
+```
+
+## All Commands
+
+### Skill Management
+
+```bash
+skillkit install <source>     # Install from GitHub/GitLab/Bitbucket/local
+skillkit remove <skills>      # Remove installed skills
+skillkit update [skills]      # Update skills from source
+skillkit list                 # List installed skills
+skillkit enable <skills>      # Enable specific skills
+skillkit disable <skills>     # Disable specific skills
+skillkit sync                 # Sync to agent config
+skillkit read <skills>        # Read skill content
+```
+
+### Discovery & Recommendations
+
+```bash
+skillkit recommend                     # Project-based recommendations
+skillkit recommend --search "auth"     # Task-based search
+skillkit recommend --category security # Filter by category
+skillkit recommend --min-score 80      # Quality threshold
+
+skillkit marketplace                   # Browse skills
+skillkit marketplace search "react"    # Search marketplace
+skillkit marketplace --tags typescript # Filter by tags
+skillkit marketplace refresh           # Refresh index
+```
+
+### Translation
+
+```bash
+skillkit translate <skill> --to <agent>  # Translate single skill
+skillkit translate --all --to cursor     # Translate all skills
+skillkit translate skill --dry-run       # Preview without writing
+```
+
+### Context Management
+
+```bash
+skillkit context init          # Analyze project, create context
+skillkit context show          # Display current context
+skillkit context sync --all    # Sync to all detected agents
+skillkit context export        # Export context file
 ```
 
-## Commands
+### Session Memory
 
 ```bash
-skillkit init              # Initialize skillkit in project
-skillkit install <skill>   # Install a skill
-skillkit remove <skill>    # Remove a skill
-skillkit list              # List installed skills
-skillkit update            # Update installed skills
-skillkit sync              # Sync skills across agents
-skillkit translate         # Translate skills between formats
-skillkit recommend         # Get skill recommendations
-skillkit context           # Manage project context
-skillkit ui                # Launch interactive TUI
+skillkit memory status         # View memory status
+skillkit memory search "auth"  # Search learnings
+skillkit memory list           # List all learnings
+skillkit memory compress       # Compress observations
+skillkit memory export <id>    # Export as skill
+skillkit memory add            # Add manual learning
+skillkit memory --global       # Use global scope
+```
+
+### Testing & Workflows
+
+```bash
+skillkit test                  # Run all skill tests
+skillkit test ./my-skill       # Test specific skill
+skillkit test --tags unit      # Run tagged tests
+
+skillkit workflow list         # List workflows
+skillkit workflow run <name>   # Execute workflow
+skillkit workflow create       # Create new workflow
+
+skillkit cicd github-action    # Generate GitHub Actions
+skillkit cicd gitlab-ci        # Generate GitLab CI
+skillkit cicd pre-commit       # Generate pre-commit hook
 ```
 
-## Usage
+### Utilities
+
+```bash
+skillkit init                  # Initialize in project
+skillkit init --agent cursor   # Initialize for specific agent
+skillkit validate ./skill      # Validate skill format
+skillkit create my-skill       # Create new skill
+```
+
+## Install Options
+
+```bash
+skillkit install owner/repo              # GitHub repository
+skillkit install gitlab:owner/repo       # GitLab repository
+skillkit install ./local/path            # Local directory
+
+# Options
+--list                    # List available skills without installing
+--skills=pdf,xlsx         # Install specific skills
+--all                     # Install all discovered skills
+--yes                     # Skip confirmation prompts
+--global                  # Install globally
+--force                   # Overwrite existing
+--agent=cursor,windsurf   # Install to specific agents
+```
+
+## Programmatic Usage
 
 ```typescript
-import { installCommand, listCommand, syncCommand } from '@skillkit/cli';
+import {
+  installCommand,
+  listCommand,
+  syncCommand,
+  translateCommand,
+  recommendCommand,
+} from '@skillkit/cli';
 
-// Programmatic access to CLI commands
-await installCommand('github.com/owner/repo:skill-name');
-await listCommand();
+// Install skills programmatically
+await installCommand('anthropics/skills', {
+  agent: ['claude-code', 'cursor'],
+  yes: true,
+});
+
+// List installed skills
+const skills = await listCommand({ json: true });
+
+// Sync to agent
 await syncCommand({ all: true });
+
+// Translate skill
+await translateCommand('my-skill', {
+  to: 'cursor',
+  dryRun: false,
+});
+
+// Get recommendations
+const recs = await recommendCommand({
+  path: './my-project',
+  minScore: 70,
+});
+```
+
+## CI/CD Usage
+
+```yaml
+# GitHub Actions example
+- name: Setup skills
+  run: |
+    npx skillkit install owner/skills --skills=lint,test --yes
+    npx skillkit sync --yes
 ```
 
+## Supported Agents
+
+| Agent | Format |
+|-------|--------|
+| Claude Code | SKILL.md |
+| Cursor | MDC (.mdc) |
+| Codex | SKILL.md |
+| Gemini CLI | SKILL.md |
+| Windsurf | Markdown |
+| GitHub Copilot | Markdown |
+| + 11 more | SKILL.md |
+
 ## Documentation
 
 Full documentation: https://github.com/rohitg00/skillkit

package/dist/index.d.ts

@@ -205,6 +205,7 @@ declare class RecommendCommand extends Command {
     verbose: boolean;
     update: boolean;
     search: string | undefined;
+    task: string | undefined;
     includeInstalled: boolean;
     json: boolean;
     projectPath: string | undefined;
@@ -239,6 +240,242 @@ declare class RecommendCommand extends Command {
     private updateIndex;
 }
 
+/**
+ * Status command - show current session state
+ */
+declare class StatusCommand extends Command {
+    static paths: string[][];
+    static usage: clipanion.Usage;
+    history: boolean;
+    limit: string | undefined;
+    json: boolean;
+    projectPath: string | undefined;
+    execute(): Promise<number>;
+    private getStatusIcon;
+    private getStatusColor;
+    private formatDuration;
+}
+
+/**
+ * Pause command - pause current skill execution
+ */
+declare class PauseCommand extends Command {
+    static paths: string[][];
+    static usage: clipanion.Usage;
+    projectPath: string | undefined;
+    execute(): Promise<number>;
+}
+
+/**
+ * Resume command - resume paused skill execution
+ */
+declare class ResumeCommand extends Command {
+    static paths: string[][];
+    static usage: clipanion.Usage;
+    projectPath: string | undefined;
+    execute(): Promise<number>;
+}
+
+/**
+ * Workflow Run command - execute a workflow
+ */
+declare class WorkflowRunCommand extends Command {
+    static paths: string[][];
+    static usage: clipanion.Usage;
+    workflowName: string | undefined;
+    file: string | undefined;
+    dryRun: boolean;
+    verbose: boolean;
+    continueOnError: boolean;
+    json: boolean;
+    projectPath: string | undefined;
+    execute(): Promise<number>;
+    private showDryRun;
+}
+
+/**
+ * Workflow List command - list available workflows
+ */
+declare class WorkflowListCommand extends Command {
+    static paths: string[][];
+    static usage: clipanion.Usage;
+    verbose: boolean;
+    json: boolean;
+    projectPath: string | undefined;
+    execute(): Promise<number>;
+}
+
+/**
+ * Workflow Create command - create a new workflow
+ */
+declare class WorkflowCreateCommand extends Command {
+    static paths: string[][];
+    static usage: clipanion.Usage;
+    workflowName: string;
+    description: string | undefined;
+    stdout: boolean;
+    projectPath: string | undefined;
+    execute(): Promise<number>;
+}
+
+/**
+ * Run command - execute a skill
+ */
+declare class RunCommand extends Command {
+    static paths: string[][];
+    static usage: clipanion.Usage;
+    skillRef: string;
+    agent: string | undefined;
+    dryRun: boolean;
+    verify: boolean;
+    autoCommit: boolean;
+    continueOnError: boolean;
+    verbose: boolean;
+    json: boolean;
+    projectPath: string | undefined;
+    execute(): Promise<number>;
+    private loadSkill;
+    private loadSkillFromFile;
+    private findInstalledSkill;
+    private parseTasksFromFrontmatter;
+    private showDryRun;
+    private getTaskTypeLabel;
+    private formatDuration;
+}
+
+/**
+ * Test command - run skill tests
+ */
+declare class TestCommand extends Command {
+    static paths: string[][];
+    static usage: clipanion.Usage;
+    skill: string | undefined;
+    verbose: boolean;
+    bail: boolean;
+    tags: string | undefined;
+    skipTags: string | undefined;
+    json: boolean;
+    projectPath: string | undefined;
+    timeout: string | undefined;
+    execute(): Promise<number>;
+    /**
+     * Find skill files with tests
+     */
+    private findSkillFiles;
+    /**
+     * Parse skill file for tests
+     */
+    private parseSkillTests;
+}
+
+/**
+ * Marketplace command - browse and install skills from the marketplace
+ */
+declare class MarketplaceCommand extends Command {
+    static paths: string[][];
+    static usage: clipanion.Usage;
+    action: string | undefined;
+    query: string | undefined;
+    limit: string | undefined;
+    tags: string | undefined;
+    source: string | undefined;
+    json: boolean;
+    execute(): Promise<number>;
+    private browseMarketplace;
+    private searchSkills;
+    private refreshIndex;
+    private showTags;
+    private showSources;
+}
+
+/**
+ * Memory command - manage session memory across AI agents
+ */
+declare class MemoryCommand extends Command {
+    static paths: string[][];
+    static usage: clipanion.Usage;
+    action: string | undefined;
+    arg: string | undefined;
+    ratingArg: string | undefined;
+    global: boolean;
+    tags: string | undefined;
+    limit: string | undefined;
+    title: string | undefined;
+    content: string | undefined;
+    name: string | undefined;
+    output: string | undefined;
+    input: string | undefined;
+    keepLearnings: boolean;
+    dryRun: boolean;
+    json: boolean;
+    verbose: boolean;
+    execute(): Promise<number>;
+    /**
+     * Show memory status
+     */
+    private showStatus;
+    /**
+     * Search memories
+     */
+    private searchMemories;
+    /**
+     * List all learnings
+     */
+    private listLearnings;
+    /**
+     * Show a specific learning
+     */
+    private showLearning;
+    /**
+     * Compress observations into learnings
+     */
+    private compressObservations;
+    /**
+     * Export a learning as a skill
+     */
+    private exportLearning;
+    /**
+     * Import memories from another project
+     */
+    private importMemories;
+    /**
+     * Clear session observations
+     */
+    private clearMemory;
+    /**
+     * Add a manual learning
+     */
+    private addLearning;
+    /**
+     * Rate a learning's effectiveness
+     */
+    private rateLearning;
+    /**
+     * Show memory configuration
+     */
+    private showConfig;
+    /**
+     * Format relevance/effectiveness score with color
+     */
+    private formatScore;
+    /**
+     * Format matched by info
+     */
+    private formatMatchedBy;
+    /**
+     * Convert title to slug
+     */
+    private slugify;
+    /**
+     * Escape a YAML scalar value if it contains special characters
+     */
+    private escapeYamlValue;
+    /**
+     * Generate skill content from learning
+     */
+    private generateSkillContent;
+}
+
 declare const loadSkillMetadata: typeof loadSkillMetadata$1;
 declare const saveSkillMetadata: typeof saveSkillMetadata$1;
 declare function getSearchDirs(agentType?: AgentType): string[];
@@ -246,4 +483,4 @@ declare function getInstallDir(global?: boolean, agentType?: AgentType): string;
 declare function getAgentConfigPath(agentType?: AgentType): string;
 declare function initProject(agentType?: AgentType): Promise<void>;
 
-export { ContextCommand, CreateCommand, DisableCommand, EnableCommand, InitCommand, InstallCommand, ListCommand, ReadCommand, RecommendCommand, RemoveCommand, SyncCommand, TranslateCommand, UICommand, UpdateCommand, ValidateCommand, getAgentConfigPath, getInstallDir, getSearchDirs, initProject, loadSkillMetadata, saveSkillMetadata };
+export { ContextCommand, CreateCommand, DisableCommand, EnableCommand, InitCommand, InstallCommand, ListCommand, MarketplaceCommand, MemoryCommand, PauseCommand, ReadCommand, RecommendCommand, RemoveCommand, ResumeCommand, RunCommand, StatusCommand, SyncCommand, TestCommand, TranslateCommand, UICommand, UpdateCommand, ValidateCommand, WorkflowCreateCommand, WorkflowListCommand, WorkflowRunCommand, getAgentConfigPath, getInstallDir, getSearchDirs, initProject, loadSkillMetadata, saveSkillMetadata };