Compare commits

..
Author SHA1 Message Date
Rohit Ghumare 2b63b37ee6 fix: address CodeRabbit and Devin review findings for skills.sh integration
- Fix path traversal vulnerability in SkillsShProvider.clone (validate subpath containment)
- Fix federated search skipped for interactive queries (use searchTerm instead of this.query)
- Guard showSkillsShStats to skip network call for local providers
- Replace deprecated npm --production with --omit=dev
- Fix loose includes() match in getSkillStats to use strict endsWith()
- Fix FederatedSearch resilience: don't re-throw RateLimitError, return partial results
- Forward timeoutMs through FederatedSearch to registries
- Extract shared formatCount utility to helpers.ts (deduplicate find.ts/install.ts)
- Fix install hint to use skill.source instead of fragile skill.description
- Fix timer leak in fetchLeaderboard using finally block
- Deduplicate URL parsing via shared parseSkillsShParts helper
- Validate --agent flag values against known agent types
2026-02-22 21:38:39 +05:30
Rohit Ghumare 57b29014ec feat: integrate skills.sh as first-class registry
Add SkillsShRegistry and SkillsShProvider so users can install skills
directly from skills.sh (e.g. `skillkit install skills.sh/owner/repo/skill`).
The find command now searches skills.sh by default alongside the local
marketplace. Post-install shows skills.sh popularity stats and pro tips
highlighting skillkit's unique features (translate, recommend, evaluate).
2026-02-22 21:38:39 +05:30
31 changed files with 1833 additions and 1731 deletions
+2 -3
View File
@@ -24,9 +24,8 @@ npm-debug.log*
# Environment
.env
**/.env
**/.env.local
**/.env.*.local
.env.local
.env.*.local
# Package manager
yarn.lock
+2 -1
View File
@@ -34,6 +34,7 @@
{ "source": "jimliu/baoyu-skills", "name": "Baoyu Tools" },
{ "source": "giuseppe-trisciuoglio/developer-kit", "name": "Shadcn / Radix" },
{ "source": "openrouterteam/agent-skills", "name": "OpenRouter SDK" },
{ "source": "intellectronica/agent-skills", "name": "Context7" }
{ "source": "intellectronica/agent-skills", "name": "Context7" },
{ "source": "skills.sh", "name": "Skills.sh Leaderboard", "official": true, "registry": "skills-sh" }
]
}
+7 -20
View File
@@ -1,4 +1,4 @@
import type { Context, Next } from "hono";
import type { Context, Next } from 'hono';
interface RateLimitEntry {
count: number;
@@ -18,12 +18,8 @@ export function rateLimiter(maxRequests = 60, windowMs = 60_000) {
}, windowMs).unref();
return async (c: Context, next: Next): Promise<Response | void> => {
const xRealIp = c.req.header("x-real-ip");
const forwarded = c.req.header("x-forwarded-for");
const forwardedIp = forwarded
? forwarded.split(",").at(-1)?.trim()
: undefined;
const ip = xRealIp || forwardedIp || "unknown";
const forwardedFor = c.req.header('x-forwarded-for');
const ip = (forwardedFor?.split(',')[0]?.trim()) || c.req.header('x-real-ip') || 'unknown';
const now = Date.now();
let entry = windows.get(ip);
@@ -34,21 +30,12 @@ export function rateLimiter(maxRequests = 60, windowMs = 60_000) {
entry.count++;
c.header("X-RateLimit-Limit", String(maxRequests));
c.header(
"X-RateLimit-Remaining",
String(Math.max(0, maxRequests - entry.count)),
);
c.header("X-RateLimit-Reset", String(Math.ceil(entry.resetAt / 1000)));
c.header('X-RateLimit-Limit', String(maxRequests));
c.header('X-RateLimit-Remaining', String(Math.max(0, maxRequests - entry.count)));
c.header('X-RateLimit-Reset', String(Math.ceil(entry.resetAt / 1000)));
if (entry.count > maxRequests) {
return c.json(
{
error: "Too many requests",
retryAfter: Math.ceil((entry.resetAt - now) / 1000),
},
429,
);
return c.json({ error: 'Too many requests', retryAfter: Math.ceil((entry.resetAt - now) / 1000) }, 429);
}
await next();
+19 -50
View File
@@ -1,5 +1,5 @@
import { Hono } from "hono";
import { ContentExtractor, SkillGenerator, AutoTagger } from "@skillkit/core";
import { Hono } from 'hono';
import { ContentExtractor, SkillGenerator, AutoTagger } from '@skillkit/core';
interface SaveRequest {
url?: string;
@@ -10,40 +10,25 @@ interface SaveRequest {
const MAX_TEXT_LENGTH = 500_000;
const BLOCKED_HOSTS = new Set([
"localhost",
"127.0.0.1",
"[::1]",
"::1",
"0.0.0.0",
]);
const BLOCKED_HOSTS = new Set(['localhost', '127.0.0.1', '[::1]', '::1', '0.0.0.0']);
function isAllowedUrl(url: string): boolean {
try {
const parsed = new URL(url);
if (parsed.protocol !== "http:" && parsed.protocol !== "https:")
return false;
if (parsed.protocol !== 'http:' && parsed.protocol !== 'https:') return false;
const hostname = parsed.hostname.toLowerCase();
const bare = hostname.replace(/^\[|\]$/g, "");
const bare = hostname.replace(/^\[|\]$/g, '');
if (BLOCKED_HOSTS.has(hostname) || BLOCKED_HOSTS.has(bare)) return false;
if (bare.startsWith("::ffff:"))
return isAllowedUrl(`http://${bare.slice(7)}`);
if (bare.startsWith('::ffff:')) return isAllowedUrl(`http://${bare.slice(7)}`);
if (/^127\./.test(bare) || /^0\./.test(bare)) return false;
if (bare.startsWith("10.") || bare.startsWith("192.168.")) return false;
if (bare.startsWith('10.') || bare.startsWith('192.168.')) return false;
if (/^172\.(1[6-9]|2\d|3[01])\./.test(bare)) return false;
if (bare.startsWith("169.254.")) return false;
if (bare.includes(":")) {
if (
bare.startsWith("fe80:") ||
bare.startsWith("fc") ||
bare.startsWith("fd")
)
return false;
if (bare.startsWith("ff")) return false;
}
if (bare.startsWith('169.254.')) return false;
if (bare.startsWith('fe80:') || bare.startsWith('fc') || bare.startsWith('fd')) return false;
if (/^(22[4-9]|23\d|24\d|25[0-5])\./.test(bare)) return false;
if (bare.startsWith('ff')) return false;
return true;
} catch {
return false;
@@ -56,12 +41,12 @@ export function saveRoutes() {
const generator = new SkillGenerator();
const tagger = new AutoTagger();
app.post("/save", async (c) => {
app.post('/save', async (c) => {
let body: SaveRequest;
try {
body = await c.req.json();
} catch {
return c.json({ error: "Invalid JSON body" }, 400);
return c.json({ error: 'Invalid JSON body' }, 400);
}
if (!body.url && !body.text) {
@@ -69,26 +54,11 @@ export function saveRoutes() {
}
if (body.url && !isAllowedUrl(body.url)) {
return c.json({ error: "URL must be a public HTTP(S) address" }, 400);
}
if (body.name && !/^[a-zA-Z0-9][a-zA-Z0-9._-]*$/.test(body.name)) {
return c.json(
{
error:
"Name must be alphanumeric (hyphens, underscores, dots allowed)",
},
400,
);
return c.json({ error: 'URL must be a public HTTP(S) address' }, 400);
}
if (body.text && body.text.length > MAX_TEXT_LENGTH) {
return c.json(
{
error: `Text exceeds maximum length of ${MAX_TEXT_LENGTH} characters`,
},
400,
);
return c.json({ error: `Text exceeds maximum length of ${MAX_TEXT_LENGTH} characters` }, 400);
}
try {
@@ -108,17 +78,16 @@ export function saveRoutes() {
tags: tagger.detectTags(content),
});
} catch (err) {
console.error("Save extraction failed:", err);
const message = err instanceof Error ? err.message : 'Unknown error';
const isTimeout =
(err instanceof DOMException && err.name === "TimeoutError") ||
(err instanceof Error &&
(err.name === "TimeoutError" || err.name === "AbortError"));
(err instanceof DOMException && err.name === 'TimeoutError') ||
(err instanceof Error && (err.name === 'TimeoutError' || err.name === 'AbortError'));
if (isTimeout) {
return c.json({ error: "Fetch timed out" }, 504);
return c.json({ error: `Fetch timeout: ${message}` }, 504);
}
return c.json({ error: "Extraction failed" }, 422);
return c.json({ error: `Extraction failed: ${message}` }, 422);
}
});
+23 -33
View File
@@ -1,15 +1,15 @@
import { Hono } from "hono";
import { cors } from "hono/cors";
import { MemoryCache } from "@skillkit/core";
import { rateLimiter } from "./middleware/rate-limit.js";
import { healthRoutes } from "./routes/health.js";
import { searchRoutes } from "./routes/search.js";
import { skillRoutes } from "./routes/skills.js";
import { trendingRoutes } from "./routes/trending.js";
import { categoryRoutes } from "./routes/categories.js";
import { docsRoutes } from "./routes/docs.js";
import { saveRoutes } from "./routes/save.js";
import type { ApiSkill, SearchResponse } from "./types.js";
import { Hono } from 'hono';
import { cors } from 'hono/cors';
import { MemoryCache } from '@skillkit/core';
import { rateLimiter } from './middleware/rate-limit.js';
import { healthRoutes } from './routes/health.js';
import { searchRoutes } from './routes/search.js';
import { skillRoutes } from './routes/skills.js';
import { trendingRoutes } from './routes/trending.js';
import { categoryRoutes } from './routes/categories.js';
import { docsRoutes } from './routes/docs.js';
import { saveRoutes } from './routes/save.js';
import type { ApiSkill, SearchResponse } from './types.js';
export interface ServerOptions {
port?: number;
@@ -29,36 +29,26 @@ export function createApp(options: ServerOptions = {}) {
const app = new Hono();
app.use("*", cors({ origin: options.corsOrigin || "*" }));
app.use("*", async (c, next) => {
await next();
c.header("X-Content-Type-Options", "nosniff");
c.header("X-Frame-Options", "DENY");
c.header(
"Content-Security-Policy",
"default-src 'self'; script-src 'self'; style-src 'self' 'unsafe-inline'",
);
c.header("Referrer-Policy", "strict-origin-when-cross-origin");
});
app.use("*", rateLimiter(options.rateLimitMax ?? 60));
app.use('*', cors({ origin: options.corsOrigin || '*' }));
app.use('*', rateLimiter(options.rateLimitMax ?? 60));
app.route("/", healthRoutes(skills.length, cache));
app.route("/", searchRoutes(skills, cache));
app.route("/", skillRoutes(skills));
app.route("/", trendingRoutes(skills));
app.route("/", categoryRoutes(skills));
app.route("/", docsRoutes());
app.route("/", saveRoutes());
app.route('/', healthRoutes(skills.length, cache));
app.route('/', searchRoutes(skills, cache));
app.route('/', skillRoutes(skills));
app.route('/', trendingRoutes(skills));
app.route('/', categoryRoutes(skills));
app.route('/', docsRoutes());
app.route('/', saveRoutes());
return { app, cache };
}
export async function startServer(options: ServerOptions = {}) {
const port = options.port ?? 3737;
const host = options.host ?? "127.0.0.1";
const host = options.host ?? '0.0.0.0';
const { app, cache } = createApp(options);
const { serve } = await import("@hono/node-server");
const { serve } = await import('@hono/node-server');
const server = serve({ fetch: app.fetch, port, hostname: host }, () => {
console.log(`SkillKit API server running at http://${host}:${port}`);
+175 -92
View File
@@ -1,4 +1,4 @@
import { Command, Option } from 'clipanion';
import { Command, Option } from "clipanion";
import {
colors,
symbols,
@@ -7,8 +7,13 @@ import {
isCancel,
select,
header,
} from '../onboarding/index.js';
import { FederatedSearch, GitHubSkillRegistry, RateLimitError } from '@skillkit/core';
} from "../onboarding/index.js";
import {
FederatedSearch,
GitHubSkillRegistry,
SkillsShRegistry,
} from "@skillkit/core";
import { formatCount } from "../helpers.js";
interface SkillResult {
name: string;
@@ -17,46 +22,46 @@ interface SkillResult {
repoName: string;
}
import skillsData from '../../../../marketplace/skills.json' with { type: 'json' };
import sourcesData from '../../../../marketplace/sources.json' with { type: 'json' };
import skillsData from "../../../../marketplace/skills.json" with { type: "json" };
import sourcesData from "../../../../marketplace/sources.json" with { type: "json" };
export class FindCommand extends Command {
static override paths = [['find'], ['search']];
static override paths = [["find"], ["search"]];
static override usage = Command.Usage({
description: 'Search for skills in the marketplace',
description: "Search for skills in the marketplace",
details: `
Quickly find and install skills from the marketplace.
Interactive mode lets you browse and install in one step.
`,
examples: [
['Interactive search', '$0 find'],
['Search for specific skill', '$0 find pdf'],
['Search with keyword', '$0 find "nextjs"'],
['List top skills', '$0 find --top'],
["Interactive search", "$0 find"],
["Search for specific skill", "$0 find pdf"],
["Search with keyword", '$0 find "nextjs"'],
["List top skills", "$0 find --top"],
],
});
query = Option.String({ required: false });
top = Option.Boolean('--top,-t', false, {
description: 'Show top/featured skills',
top = Option.Boolean("--top,-t", false, {
description: "Show top/featured skills",
});
limit = Option.String('--limit,-l', '10', {
description: 'Maximum results to show',
limit = Option.String("--limit,-l", "10", {
description: "Maximum results to show",
});
install = Option.Boolean('--install,-i', false, {
description: 'Prompt to install after finding',
install = Option.Boolean("--install,-i", false, {
description: "Prompt to install after finding",
});
quiet = Option.Boolean('--quiet,-q', false, {
description: 'Minimal output (just list skills)',
quiet = Option.Boolean("--quiet,-q", false, {
description: "Minimal output (just list skills)",
});
federated = Option.Boolean('--federated,-f', false, {
description: 'Search external registries (GitHub SKILL.md files)',
federated = Option.Boolean("--federated,-f", false, {
description: "Search external registries (GitHub SKILL.md files)",
});
async execute(): Promise<number> {
@@ -64,17 +69,25 @@ export class FindCommand extends Command {
const limit = parseInt(this.limit, 10) || 10;
if (!this.quiet) {
header('Find Skills');
header("Find Skills");
}
const allSkills: SkillResult[] = (skillsData.skills || []).map((skill: { name: string; description?: string; source?: string; repo?: string }) => ({
name: skill.name,
description: skill.description,
source: skill.source || '',
repoName: skill.repo || skill.source?.split('/').pop() || '',
}));
const allSkills: SkillResult[] = (skillsData.skills || []).map(
(skill: {
name: string;
description?: string;
source?: string;
repo?: string;
}) => ({
name: skill.name,
description: skill.description,
source: skill.source || "",
repoName: skill.repo || skill.source?.split("/").pop() || "",
}),
);
let results: SkillResult[];
let searchTerm: string | undefined;
if (this.top) {
const featured = sourcesData.sources
@@ -82,35 +95,43 @@ export class FindCommand extends Command {
.slice(0, 5);
results = allSkills
.filter(skill => featured.some((f: { source: string }) => skill.source.includes(f.source)))
.filter((skill) =>
featured.some((f: { source: string }) =>
skill.source.includes(f.source),
),
)
.slice(0, limit);
if (!this.quiet) {
step('Showing featured skills');
step("Showing featured skills");
}
} else if (this.query) {
const query = this.query.toLowerCase();
searchTerm = this.query;
s.start('Searching...');
s.start("Searching...");
results = allSkills.filter(skill =>
skill.name.toLowerCase().includes(query) ||
skill.description?.toLowerCase().includes(query) ||
skill.source.toLowerCase().includes(query) ||
skill.repoName.toLowerCase().includes(query)
).slice(0, limit);
results = allSkills
.filter(
(skill) =>
skill.name.toLowerCase().includes(query) ||
skill.description?.toLowerCase().includes(query) ||
skill.source.toLowerCase().includes(query) ||
skill.repoName.toLowerCase().includes(query),
)
.slice(0, limit);
s.stop(`Found ${results.length} skill(s)`);
} else {
if (!this.quiet) {
step('Enter a search term or browse featured skills');
step("Enter a search term or browse featured skills");
}
const { text } = await import('../onboarding/prompts.js');
const { text } = await import("../onboarding/prompts.js");
const searchResult = await text({
message: 'Search skills',
placeholder: 'e.g., pdf, nextjs, testing',
message: "Search skills",
placeholder: "e.g., pdf, nextjs, testing",
});
if (isCancel(searchResult)) {
@@ -118,101 +139,163 @@ export class FindCommand extends Command {
}
const query = (searchResult as string).toLowerCase();
searchTerm = searchResult as string;
if (query) {
s.start('Searching...');
results = allSkills.filter(skill =>
skill.name.toLowerCase().includes(query) ||
skill.description?.toLowerCase().includes(query) ||
skill.source.toLowerCase().includes(query) ||
skill.repoName.toLowerCase().includes(query)
).slice(0, limit);
s.start("Searching...");
results = allSkills
.filter(
(skill) =>
skill.name.toLowerCase().includes(query) ||
skill.description?.toLowerCase().includes(query) ||
skill.source.toLowerCase().includes(query) ||
skill.repoName.toLowerCase().includes(query),
)
.slice(0, limit);
s.stop(`Found ${results.length} skill(s)`);
} else {
results = allSkills.slice(0, limit);
}
}
if (this.federated && this.query) {
s.start('Searching external registries...');
if (searchTerm) {
s.start("Searching skills.sh + external registries...");
const fedSearch = new FederatedSearch();
fedSearch.addRegistry(new GitHubSkillRegistry());
fedSearch.addRegistry(new SkillsShRegistry());
if (this.federated) {
fedSearch.addRegistry(new GitHubSkillRegistry());
}
try {
const fedResult = await fedSearch.search(this.query, { limit: parseInt(this.limit, 10) || 10 });
s.stop(`Found ${fedResult.total} external skill(s) from ${fedResult.registries.join(', ') || 'none'}`);
const fedResult = await fedSearch.search(searchTerm, {
limit: parseInt(this.limit, 10) || 10,
});
const sourceLabel = fedResult.registries.join(", ") || "none";
s.stop(`Found ${fedResult.total} skill(s) from ${sourceLabel}`);
if (fedResult.skills.length > 0) {
console.log('');
console.log(colors.bold('External Skills (SKILL.md):'));
for (const skill of fedResult.skills) {
const stars = typeof skill.stars === 'number' ? colors.muted(` ★${skill.stars}`) : '';
const desc = skill.description
? colors.muted(` - ${skill.description.slice(0, 50)}${skill.description.length > 50 ? '...' : ''}`)
: '';
console.log(` ${colors.cyan(symbols.bullet)} ${colors.primary(skill.name)}${stars}${desc}`);
if (!this.quiet) {
console.log(` ${colors.muted(skill.source)}`);
const skillsShResults = fedResult.skills.filter(
(sk) => sk.registry === "skills.sh",
);
const githubResults = fedResult.skills.filter(
(sk) => sk.registry !== "skills.sh",
);
if (skillsShResults.length > 0) {
console.log("");
console.log(colors.bold("Skills.sh Registry:"));
for (const skill of skillsShResults) {
const installs =
typeof skill.stars === "number" && skill.stars > 0
? colors.muted(` ${formatCount(skill.stars)} installs`)
: "";
const desc = skill.description
? colors.muted(
` - ${skill.description.slice(0, 50)}${skill.description.length > 50 ? "..." : ""}`,
)
: "";
console.log(
` ${colors.cyan(symbols.bullet)} ${colors.primary(skill.name)}${installs}${desc}`,
);
if (!this.quiet) {
const installSource = skill.source.replace(
"https://github.com/",
"",
);
console.log(
` ${colors.muted(`skillkit install skills.sh/${installSource}/${skill.name}`)}`,
);
}
}
}
console.log('');
}
} catch (err) {
if (err instanceof RateLimitError) {
s.stop(colors.warning('Rate limited by GitHub API'));
console.log(colors.muted('Set GITHUB_TOKEN env var or wait before retrying.'));
} else {
s.stop(colors.warning('Federated search failed'));
if (githubResults.length > 0) {
console.log("");
console.log(colors.bold("GitHub (SKILL.md):"));
for (const skill of githubResults) {
const stars =
typeof skill.stars === "number"
? colors.muted(` ★${skill.stars}`)
: "";
const desc = skill.description
? colors.muted(
` - ${skill.description.slice(0, 50)}${skill.description.length > 50 ? "..." : ""}`,
)
: "";
console.log(
` ${colors.cyan(symbols.bullet)} ${colors.primary(skill.name)}${stars}${desc}`,
);
if (!this.quiet) {
console.log(` ${colors.muted(skill.source)}`);
}
}
}
console.log("");
}
} catch {
s.stop(colors.warning("External search unavailable"));
}
}
if (results.length === 0) {
console.log(colors.muted('No skills found matching your search'));
console.log('');
console.log(colors.muted('Try:'));
console.log(colors.muted(' skillkit find --top # Show featured skills'));
console.log(colors.muted(' skillkit find -f <query> # Search external registries'));
console.log(colors.muted(' skillkit ui # Browse in TUI'));
console.log(colors.muted("No skills found matching your search"));
console.log("");
console.log(colors.muted("Try:"));
console.log(
colors.muted(" skillkit find --top # Show featured skills"),
);
console.log(
colors.muted(
" skillkit find -f <query> # Also search GitHub SKILL.md files",
),
);
console.log(colors.muted(" skillkit ui # Browse in TUI"));
return 0;
}
console.log('');
console.log("");
for (const skill of results) {
const desc = skill.description
? colors.muted(` - ${skill.description.slice(0, 50)}${skill.description.length > 50 ? '...' : ''}`)
: '';
console.log(` ${colors.success(symbols.bullet)} ${colors.primary(skill.name)}${desc}`);
? colors.muted(
` - ${skill.description.slice(0, 50)}${skill.description.length > 50 ? "..." : ""}`,
)
: "";
console.log(
` ${colors.success(symbols.bullet)} ${colors.primary(skill.name)}${desc}`,
);
if (!this.quiet && skill.source) {
console.log(` ${colors.muted(skill.source)}`);
}
}
console.log('');
console.log(colors.muted(`Showing ${results.length} of ${allSkills.length} skills`));
console.log('');
console.log("");
console.log(
colors.muted(`Showing ${results.length} of ${allSkills.length} skills`),
);
console.log("");
if (this.install || (!this.query && !this.top && process.stdin.isTTY)) {
const installResult = await select({
message: 'Install a skill?',
message: "Install a skill?",
options: [
{ value: 'none', label: 'No, just browsing' },
...results.slice(0, 5).map(skill => ({
{ value: "none", label: "No, just browsing" },
...results.slice(0, 5).map((skill) => ({
value: skill.source,
label: skill.name,
hint: skill.repoName,
})),
],
initialValue: 'none',
initialValue: "none",
});
if (!isCancel(installResult) && installResult !== 'none') {
console.log('');
console.log(colors.cyan('To install, run:'));
if (!isCancel(installResult) && installResult !== "none") {
console.log("");
console.log(colors.cyan("To install, run:"));
console.log(` ${colors.bold(`skillkit install ${installResult}`)}`);
}
} else {
console.log(colors.muted('To install: skillkit install <source>'));
console.log(colors.muted("To install: skillkit install <source>"));
}
return 0;
+334 -131
View File
@@ -1,15 +1,36 @@
import { existsSync, mkdirSync, cpSync, rmSync, symlinkSync, readFileSync, writeFileSync } from 'node:fs';
import { join } from 'node:path';
import { execFile } from 'node:child_process';
import { promisify } from 'node:util';
import {
existsSync,
mkdirSync,
cpSync,
rmSync,
symlinkSync,
readFileSync,
writeFileSync,
} from "node:fs";
import { join } from "node:path";
import { execFile } from "node:child_process";
import { promisify } from "node:util";
const execFileAsync = promisify(execFile);
import { Command, Option } from 'clipanion';
import { detectProvider, isLocalPath, getProvider, evaluateSkillDirectory, SkillScanner, formatSummary, Severity, WellKnownProvider, AgentsMdParser, AgentsMdGenerator } from '@skillkit/core';
import type { SkillMetadata, GitProvider, AgentType } from '@skillkit/core';
import { isPathInside } from '@skillkit/core';
import { getAdapter, detectAgent, getAllAdapters } from '@skillkit/agents';
import { getInstallDir, saveSkillMetadata } from '../helpers.js';
import { Command, Option } from "clipanion";
import {
detectProvider,
isLocalPath,
getProvider,
evaluateSkillDirectory,
SkillScanner,
formatSummary,
Severity,
WellKnownProvider,
AgentsMdParser,
AgentsMdGenerator,
SkillsShRegistry,
} from "@skillkit/core";
import type { SkillsShStats } from "@skillkit/core";
import type { SkillMetadata, GitProvider, AgentType } from "@skillkit/core";
import { isPathInside } from "@skillkit/core";
import { getAdapter, detectAgent, getAllAdapters } from "@skillkit/agents";
import { getInstallDir, saveSkillMetadata, formatCount } from "../helpers.js";
import {
welcome,
colors,
@@ -35,71 +56,80 @@ import {
formatQualityBadge,
getQualityGradeFromScore,
type InstallResult,
} from '../onboarding/index.js';
} from "../onboarding/index.js";
export class InstallCommand extends Command {
static override paths = [['install'], ['i'], ['add']];
static override paths = [["install"], ["i"], ["add"]];
static override usage = Command.Usage({
description: 'Install skills from GitHub, GitLab, Bitbucket, or local path',
description:
"Install skills from GitHub, GitLab, Bitbucket, skills.sh, or local path",
examples: [
['Install from GitHub', '$0 install owner/repo'],
['Install from GitLab', '$0 install gitlab:owner/repo'],
['Install from Bitbucket', '$0 install bitbucket:owner/repo'],
['Install specific skill', '$0 install owner/repo --skill=pdf'],
['Install multiple skills (CI/CD)', '$0 install owner/repo --skills=pdf,xlsx'],
['Install all skills non-interactively', '$0 install owner/repo --all'],
['Install from local path', '$0 install ./my-skills'],
['Install globally', '$0 install owner/repo --global'],
['List available skills', '$0 install owner/repo --list'],
['Install to specific agents', '$0 install owner/repo --agent claude-code --agent cursor'],
["Install from GitHub", "$0 install owner/repo"],
["Install from skills.sh", "$0 install skills.sh/owner/repo/skill-name"],
["Install from GitLab", "$0 install gitlab:owner/repo"],
["Install from Bitbucket", "$0 install bitbucket:owner/repo"],
["Install specific skill", "$0 install owner/repo --skill=pdf"],
[
"Install multiple skills (CI/CD)",
"$0 install owner/repo --skills=pdf,xlsx",
],
["Install all skills non-interactively", "$0 install owner/repo --all"],
["Install from local path", "$0 install ./my-skills"],
["Install globally", "$0 install owner/repo --global"],
["List available skills", "$0 install owner/repo --list"],
[
"Install to specific agents",
"$0 install owner/repo --agent claude-code --agent cursor",
],
],
});
source = Option.String({ required: true });
skills = Option.String('--skills,--skill,-s', {
description: 'Comma-separated list of skills to install (non-interactive)',
skills = Option.String("--skills,--skill,-s", {
description: "Comma-separated list of skills to install (non-interactive)",
});
all = Option.Boolean('--all,-a', false, {
description: 'Install all discovered skills (non-interactive)',
all = Option.Boolean("--all,-a", false, {
description: "Install all discovered skills (non-interactive)",
});
yes = Option.Boolean('--yes,-y', false, {
description: 'Skip confirmation prompts',
yes = Option.Boolean("--yes,-y", false, {
description: "Skip confirmation prompts",
});
global = Option.Boolean('--global,-g', false, {
description: 'Install to global skills directory',
global = Option.Boolean("--global,-g", false, {
description: "Install to global skills directory",
});
force = Option.Boolean('--force,-f', false, {
description: 'Overwrite existing skills',
force = Option.Boolean("--force,-f", false, {
description: "Overwrite existing skills",
});
provider = Option.String('--provider,-p', {
description: 'Force specific provider (github, gitlab, bitbucket)',
provider = Option.String("--provider,-p", {
description: "Force specific provider (github, gitlab, bitbucket)",
});
list = Option.Boolean('--list,-l', false, {
description: 'List available skills without installing',
list = Option.Boolean("--list,-l", false, {
description: "List available skills without installing",
});
agent = Option.Array('--agent', {
description: 'Target specific agents (can specify multiple)',
agent = Option.Array("--agent", {
description: "Target specific agents (can specify multiple)",
});
quiet = Option.Boolean('--quiet,-q', false, {
description: 'Minimal output (no logo)',
quiet = Option.Boolean("--quiet,-q", false, {
description: "Minimal output (no logo)",
});
scan = Option.Boolean('--scan', true, {
description: 'Run security scan before installing (default: true)',
scan = Option.Boolean("--scan", true, {
description: "Run security scan before installing (default: true)",
});
async execute(): Promise<number> {
const isInteractive = process.stdin.isTTY && !this.skills && !this.all && !this.yes;
const isInteractive =
process.stdin.isTTY && !this.skills && !this.all && !this.yes;
const s = spinner();
try {
@@ -109,21 +139,37 @@ export class InstallCommand extends Command {
}
let providerAdapter = detectProvider(this.source);
let result: { success: boolean; path?: string; tempRoot?: string; error?: string; skills?: string[]; discoveredSkills?: Array<{ name: string; dirName: string; path: string }> } | null = null;
let result: {
success: boolean;
path?: string;
tempRoot?: string;
error?: string;
skills?: string[];
discoveredSkills?: Array<{
name: string;
dirName: string;
path: string;
}>;
} | null = null;
const isUrl = this.source.startsWith('http://') || this.source.startsWith('https://');
const isUrl =
this.source.startsWith("http://") || this.source.startsWith("https://");
if (isUrl && !this.provider && !providerAdapter) {
s.start('Checking for well-known skills...');
s.start("Checking for well-known skills...");
const wellKnown = new WellKnownProvider();
const discovery = await wellKnown.discoverFromUrl(this.source);
if (discovery.success) {
s.stop(`Found ${discovery.skills?.length || 0} skill(s) via well-known discovery`);
s.stop(
`Found ${discovery.skills?.length || 0} skill(s) via well-known discovery`,
);
providerAdapter = wellKnown;
result = discovery;
} else {
s.stop('No well-known skills found');
s.stop("No well-known skills found");
warn(`No well-known skills found at ${this.source}`);
console.log(colors.muted('You can save this URL as a skill instead:'));
console.log(
colors.muted("You can save this URL as a skill instead:"),
);
console.log(colors.muted(` skillkit save ${this.source}`));
return 1;
}
@@ -135,20 +181,31 @@ export class InstallCommand extends Command {
if (!providerAdapter) {
error(`Could not detect provider for: ${this.source}`);
console.log(colors.muted('Use --provider flag or specify source as:'));
console.log(colors.muted(' GitHub: owner/repo or https://github.com/owner/repo'));
console.log(colors.muted(' GitLab: gitlab:owner/repo or https://gitlab.com/owner/repo'));
console.log(colors.muted(' Bitbucket: bitbucket:owner/repo'));
console.log(colors.muted(' Local: ./path or ~/path'));
console.log(colors.muted("Use --provider flag or specify source as:"));
console.log(
colors.muted(
" GitHub: owner/repo or https://github.com/owner/repo",
),
);
console.log(
colors.muted(" Skills.sh: skills.sh/owner/repo/skill-name"),
);
console.log(
colors.muted(
" GitLab: gitlab:owner/repo or https://gitlab.com/owner/repo",
),
);
console.log(colors.muted(" Bitbucket: bitbucket:owner/repo"));
console.log(colors.muted(" Local: ./path or ~/path"));
return 1;
}
if (!result) {
s.start(`Fetching from ${providerAdapter.name}...`);
result = await providerAdapter.clone(this.source, '', { depth: 1 });
result = await providerAdapter.clone(this.source, "", { depth: 1 });
if (!result.success || !result.path) {
s.stop(colors.error(result.error || 'Failed to fetch source'));
s.stop(colors.error(result.error || "Failed to fetch source"));
return 1;
}
@@ -161,23 +218,35 @@ export class InstallCommand extends Command {
// List mode - just show skills and exit
if (this.list) {
if (discoveredSkills.length === 0) {
warn('No skills found in this repository');
warn("No skills found in this repository");
} else {
console.log('');
console.log(colors.bold('Available skills:'));
console.log('');
console.log("");
console.log(colors.bold("Available skills:"));
console.log("");
for (const skill of discoveredSkills) {
const quality = evaluateSkillDirectory(skill.path);
const qualityBadge = quality ? ` ${formatQualityBadge(quality.overall)}` : '';
console.log(` ${colors.success(symbols.stepActive)} ${colors.primary(skill.name)}${qualityBadge}`);
const qualityBadge = quality
? ` ${formatQualityBadge(quality.overall)}`
: "";
console.log(
` ${colors.success(symbols.stepActive)} ${colors.primary(skill.name)}${qualityBadge}`,
);
}
console.log('');
console.log(colors.muted(`Total: ${discoveredSkills.length} skill(s)`));
console.log(colors.muted('To install: skillkit install <source> --skill=name'));
console.log("");
console.log(
colors.muted(`Total: ${discoveredSkills.length} skill(s)`),
);
console.log(
colors.muted("To install: skillkit install <source> --skill=name"),
);
}
const cleanupPath = cloneResult.tempRoot || cloneResult.path;
if (!isLocalPath(this.source) && cleanupPath && existsSync(cleanupPath)) {
if (
!isLocalPath(this.source) &&
cleanupPath &&
existsSync(cleanupPath)
) {
rmSync(cleanupPath, { recursive: true, force: true });
}
@@ -188,17 +257,19 @@ export class InstallCommand extends Command {
// Non-interactive: use --skills filter
if (this.skills) {
const requestedSkills = this.skills.split(',').map(s => s.trim());
const available = discoveredSkills.map(s => s.name);
const notFound = requestedSkills.filter(s => !available.includes(s));
const requestedSkills = this.skills.split(",").map((s) => s.trim());
const available = discoveredSkills.map((s) => s.name);
const notFound = requestedSkills.filter((s) => !available.includes(s));
if (notFound.length > 0) {
error(`Skills not found: ${notFound.join(', ')}`);
console.log(colors.muted(`Available: ${available.join(', ')}`));
error(`Skills not found: ${notFound.join(", ")}`);
console.log(colors.muted(`Available: ${available.join(", ")}`));
return 1;
}
skillsToInstall = discoveredSkills.filter(s => requestedSkills.includes(s.name));
skillsToInstall = discoveredSkills.filter((s) =>
requestedSkills.includes(s.name),
);
} else if (this.all || this.yes) {
skillsToInstall = discoveredSkills;
} else if (isInteractive && discoveredSkills.length > 1) {
@@ -206,21 +277,23 @@ export class InstallCommand extends Command {
step(`Source: ${colors.cyan(this.source)}`);
const skillResult = await skillMultiselect({
message: 'Select skills to install',
skills: discoveredSkills.map(s => ({ name: s.name })),
initialValues: discoveredSkills.map(s => s.name),
message: "Select skills to install",
skills: discoveredSkills.map((s) => ({ name: s.name })),
initialValues: discoveredSkills.map((s) => s.name),
});
if (isCancel(skillResult)) {
cancel('Installation cancelled');
cancel("Installation cancelled");
return 0;
}
skillsToInstall = discoveredSkills.filter(s => (skillResult as string[]).includes(s.name));
skillsToInstall = discoveredSkills.filter((s) =>
(skillResult as string[]).includes(s.name),
);
}
if (skillsToInstall.length === 0) {
warn('No skills to install');
warn("No skills to install");
return 0;
}
@@ -228,26 +301,35 @@ export class InstallCommand extends Command {
let targetAgents: AgentType[];
if (this.agent && this.agent.length > 0) {
// Explicitly specified agents
const allValid = getAllAdapters().map((a) => a.type);
const invalid = this.agent.filter(
(a) => !allValid.includes(a as AgentType),
);
if (invalid.length > 0) {
error(`Unknown agent(s): ${invalid.join(", ")}`);
console.log(colors.muted(`Available: ${allValid.join(", ")}`));
return 1;
}
targetAgents = this.agent as AgentType[];
} else if (isInteractive) {
const allAgentTypes = getAllAdapters().map(a => a.type);
const allAgentTypes = getAllAdapters().map((a) => a.type);
const lastAgents = getLastAgents();
step(`Detected ${allAgentTypes.length} agents`);
const agentResult = await quickAgentSelect({
message: 'Install to',
message: "Install to",
agents: allAgentTypes,
lastSelected: lastAgents,
});
if (isCancel(agentResult)) {
cancel('Installation cancelled');
cancel("Installation cancelled");
return 0;
}
targetAgents = (agentResult as { agents: string[] }).agents as AgentType[];
targetAgents = (agentResult as { agents: string[] })
.agents as AgentType[];
// Save selection for next time
saveLastAgents(targetAgents);
@@ -258,21 +340,25 @@ export class InstallCommand extends Command {
}
// Interactive: select installation method
let installMethod: 'symlink' | 'copy' = 'copy';
let installMethod: "symlink" | "copy" = "copy";
if (isInteractive && targetAgents.length > 1) {
const methodResult = await selectInstallMethod({});
if (isCancel(methodResult)) {
cancel('Installation cancelled');
cancel("Installation cancelled");
return 0;
}
installMethod = methodResult as 'symlink' | 'copy';
installMethod = methodResult as "symlink" | "copy";
}
// Check for low-quality skills and warn
const lowQualitySkills: Array<{ name: string; score: number; warnings: string[] }> = [];
const lowQualitySkills: Array<{
name: string;
score: number;
warnings: string[];
}> = [];
for (const skill of skillsToInstall) {
const quality = evaluateSkillDirectory(skill.path);
if (quality && quality.overall < 60) {
@@ -289,42 +375,60 @@ export class InstallCommand extends Command {
for (const skill of skillsToInstall) {
const scanResult = await scanner.scan(skill.path);
if (scanResult.verdict === 'fail' && !this.force) {
if (scanResult.verdict === "fail" && !this.force) {
error(`Security scan FAILED for "${skill.name}"`);
console.log(formatSummary(scanResult));
console.log(colors.muted('Use --force to install anyway, or --no-scan to skip scanning'));
console.log(
colors.muted(
"Use --force to install anyway, or --no-scan to skip scanning",
),
);
const cleanupPath = cloneResult.tempRoot || cloneResult.path;
if (!isLocalPath(this.source) && cleanupPath && existsSync(cleanupPath)) {
if (
!isLocalPath(this.source) &&
cleanupPath &&
existsSync(cleanupPath)
) {
rmSync(cleanupPath, { recursive: true, force: true });
}
return 1;
}
if (scanResult.verdict === 'warn' && !this.quiet) {
warn(`Security warnings for "${skill.name}" (${scanResult.stats.medium} medium, ${scanResult.stats.low} low)`);
if (scanResult.verdict === "warn" && !this.quiet) {
warn(
`Security warnings for "${skill.name}" (${scanResult.stats.medium} medium, ${scanResult.stats.low} low)`,
);
}
}
}
// Confirm installation
if (isInteractive && !this.yes) {
console.log('');
console.log("");
// Show low-quality warning if any
if (lowQualitySkills.length > 0) {
console.log(colors.warning(`${symbols.warning} Warning: ${lowQualitySkills.length} skill(s) have low quality scores (< 60)`));
console.log(
colors.warning(
`${symbols.warning} Warning: ${lowQualitySkills.length} skill(s) have low quality scores (< 60)`,
),
);
for (const lq of lowQualitySkills) {
const grade = getQualityGradeFromScore(lq.score);
const warningText = lq.warnings.length > 0 ? ` - ${lq.warnings.join(', ')}` : '';
console.log(colors.muted(` - ${lq.name} [${grade}]${warningText}`));
const warningText =
lq.warnings.length > 0 ? ` - ${lq.warnings.join(", ")}` : "";
console.log(
colors.muted(` - ${lq.name} [${grade}]${warningText}`),
);
}
console.log('');
console.log("");
}
const agentDisplay = targetAgents.length <= 3
? targetAgents.map(formatAgent).join(', ')
: `${targetAgents.slice(0, 2).map(formatAgent).join(', ')} +${targetAgents.length - 2} more`;
const agentDisplay =
targetAgents.length <= 3
? targetAgents.map(formatAgent).join(", ")
: `${targetAgents.slice(0, 2).map(formatAgent).join(", ")} +${targetAgents.length - 2} more`;
const confirmResult = await confirm({
message: `Install ${skillsToInstall.length} skill(s) to ${agentDisplay}?`,
@@ -332,7 +436,7 @@ export class InstallCommand extends Command {
});
if (isCancel(confirmResult) || !confirmResult) {
cancel('Installation cancelled');
cancel("Installation cancelled");
return 0;
}
}
@@ -359,21 +463,26 @@ export class InstallCommand extends Command {
if (existsSync(targetPath) && !this.force) {
if (!this.quiet) {
warn(`Skipping ${skillName} for ${adapter.name} (already exists, use --force)`);
warn(
`Skipping ${skillName} for ${adapter.name} (already exists, use --force)`,
);
}
continue;
}
const securityRoot = cloneResult.tempRoot || cloneResult.path || '';
const securityRoot = cloneResult.tempRoot || cloneResult.path || "";
if (!securityRoot || !isPathInside(sourcePath, securityRoot)) {
error(`Skipping ${skillName} (path traversal detected)`);
continue;
}
const isSymlinkMode = installMethod === 'symlink' && targetAgents.length > 1;
const isSymlinkMode =
installMethod === "symlink" && targetAgents.length > 1;
const useSymlink = isSymlinkMode && primaryPath !== null;
s.start(`Installing ${skillName} to ${adapter.name}${useSymlink ? ' (symlink)' : ''}...`);
s.start(
`Installing ${skillName} to ${adapter.name}${useSymlink ? " (symlink)" : ""}...`,
);
try {
if (existsSync(targetPath)) {
@@ -381,24 +490,33 @@ export class InstallCommand extends Command {
}
if (useSymlink && primaryPath) {
symlinkSync(primaryPath, targetPath, 'dir');
symlinkSync(primaryPath, targetPath, "dir");
} else {
cpSync(sourcePath, targetPath, { recursive: true, dereference: true });
cpSync(sourcePath, targetPath, {
recursive: true,
dereference: true,
});
if (isSymlinkMode && primaryPath === null) {
primaryPath = targetPath;
}
// Auto-install npm dependencies if package.json exists
const packageJsonPath = join(targetPath, 'package.json');
const packageJsonPath = join(targetPath, "package.json");
if (existsSync(packageJsonPath)) {
s.stop(`Installed ${skillName} to ${adapter.name}`);
s.start(`Installing npm dependencies for ${skillName}...`);
try {
await execFileAsync('npm', ['install', '--production'], { cwd: targetPath });
await execFileAsync("npm", ["install", "--omit=dev"], {
cwd: targetPath,
});
s.stop(`Installed dependencies for ${skillName}`);
} catch (npmErr) {
s.stop(colors.warning(`Dependencies failed for ${skillName}`));
console.log(colors.muted('Run manually: npm install in ' + targetPath));
s.stop(
colors.warning(`Dependencies failed for ${skillName}`),
);
console.log(
colors.muted("Run manually: npm install in " + targetPath),
);
}
s.start(`Finishing ${skillName} installation...`);
}
@@ -406,7 +524,7 @@ export class InstallCommand extends Command {
const metadata: SkillMetadata = {
name: skillName,
description: '',
description: "",
source: this.source,
sourceType: providerAdapter.type,
subpath: skillName,
@@ -416,10 +534,16 @@ export class InstallCommand extends Command {
saveSkillMetadata(targetPath, metadata);
installedAgents.push(agentType);
s.stop(`Installed ${skillName} to ${adapter.name}${useSymlink ? ' (symlink)' : ''}`);
s.stop(
`Installed ${skillName} to ${adapter.name}${useSymlink ? " (symlink)" : ""}`,
);
} catch (err) {
s.stop(colors.error(`Failed to install ${skillName} to ${adapter.name}`));
console.log(colors.muted(err instanceof Error ? err.message : String(err)));
s.stop(
colors.error(`Failed to install ${skillName} to ${adapter.name}`),
);
console.log(
colors.muted(err instanceof Error ? err.message : String(err)),
);
}
}
@@ -429,7 +553,10 @@ export class InstallCommand extends Command {
skillName,
method: installMethod,
agents: installedAgents,
path: join(getInstallDir(this.global, installedAgents[0] as AgentType), skillName),
path: join(
getInstallDir(this.global, installedAgents[0] as AgentType),
skillName,
),
});
}
}
@@ -442,19 +569,22 @@ export class InstallCommand extends Command {
if (totalInstalled > 0) {
try {
const agentsMdPath = join(process.cwd(), 'AGENTS.md');
const agentsMdPath = join(process.cwd(), "AGENTS.md");
if (existsSync(agentsMdPath)) {
const parser = new AgentsMdParser();
const existing = readFileSync(agentsMdPath, 'utf-8');
const existing = readFileSync(agentsMdPath, "utf-8");
if (parser.hasManagedSections(existing)) {
const gen = new AgentsMdGenerator({ projectPath: process.cwd() });
const genResult = gen.generate();
const updated = parser.updateManagedSections(existing, genResult.sections.filter(s => s.managed));
writeFileSync(agentsMdPath, updated, 'utf-8');
const updated = parser.updateManagedSections(
existing,
genResult.sections.filter((s) => s.managed),
);
writeFileSync(agentsMdPath, updated, "utf-8");
}
}
} catch {
warn('Failed to update AGENTS.md');
warn("Failed to update AGENTS.md");
}
}
@@ -468,32 +598,105 @@ export class InstallCommand extends Command {
source: this.source,
});
outro('Installation complete!');
await this.showSkillsShStats(
installResults.map((r) => r.skillName),
providerAdapter,
);
outro("Installation complete!");
if (!this.yes) {
showNextSteps({
skillNames: installResults.map(r => r.skillName),
skillNames: installResults.map((r) => r.skillName),
agentTypes: targetAgents,
syncNeeded: true,
});
this.showProTips(installResults.map((r) => r.skillName));
}
} else {
success(`Installed ${totalInstalled} skill(s) to ${targetAgents.length} agent(s)`);
success(
`Installed ${totalInstalled} skill(s) to ${targetAgents.length} agent(s)`,
);
for (const r of installResults) {
console.log(colors.muted(` ${symbols.success} ${r.skillName} ${symbols.arrowRight} ${r.agents.map(getAgentIcon).join(' ')}`));
console.log(
colors.muted(
` ${symbols.success} ${r.skillName} ${symbols.arrowRight} ${r.agents.map(getAgentIcon).join(" ")}`,
),
);
}
console.log('');
console.log(colors.muted('Run `skillkit sync` to update agent configs'));
console.log("");
console.log(
colors.muted("Run `skillkit sync` to update agent configs"),
);
}
} else {
warn('No skills were installed');
warn("No skills were installed");
}
return 0;
} catch (err) {
s.stop(colors.error('Installation failed'));
console.log(colors.muted(err instanceof Error ? err.message : String(err)));
s.stop(colors.error("Installation failed"));
console.log(
colors.muted(err instanceof Error ? err.message : String(err)),
);
return 1;
}
}
private async showSkillsShStats(
skillNames: string[],
provider: {
type: string;
parseSource: (s: string) => { owner: string; repo: string } | null;
},
): Promise<void> {
try {
if (provider.type === "local") return;
const parsed = provider.parseSource(this.source);
if (!parsed) return;
const registry = new SkillsShRegistry();
const statsResults: SkillsShStats[] = [];
for (const name of skillNames) {
const stats = await registry.getSkillStats(
parsed.owner,
parsed.repo,
name,
);
if (stats) statsResults.push(stats);
}
if (statsResults.length > 0) {
console.log("");
console.log(colors.bold("Skills.sh Popularity:"));
for (const s of statsResults) {
const rank =
s.rank <= 10
? colors.success(`#${s.rank}`)
: colors.muted(`#${s.rank}`);
const installs = s.installs > 0 ? formatCount(s.installs) : "n/a";
console.log(
` ${rank} ${colors.primary(s.skillName)} ${colors.muted(`(${installs} installs)`)}`,
);
}
}
} catch {
// Non-critical, silently skip
}
}
private showProTips(skillNames: string[]): void {
const tips = [
`Translate to any agent format: ${colors.bold(`skillkit translate ${skillNames[0] || "skill-name"} --to cursor`)}`,
`Get AI recommendations: ${colors.bold("skillkit recommend")}`,
`Score quality: ${colors.bold(`skillkit evaluate ${skillNames[0] || "skill-name"}`)}`,
`Browse all skills: ${colors.bold("skillkit find --top")}`,
];
const tip = tips[Math.floor(Math.random() * tips.length)];
console.log("");
console.log(colors.muted(`Pro tip: ${tip}`));
}
}
+222 -302
View File
@@ -1,31 +1,13 @@
import {
existsSync,
readFileSync,
mkdirSync,
writeFileSync,
readdirSync,
statSync,
} from "node:fs";
import { join, basename, dirname, resolve, sep } from "node:path";
import chalk from "chalk";
import { Command, Option } from "clipanion";
import {
generateWellKnownIndex,
type WellKnownSkill,
SkillScanner,
formatSummary,
Severity,
} from "@skillkit/core";
import { existsSync, readFileSync, mkdirSync, writeFileSync, readdirSync, statSync } from 'node:fs';
import { join, basename, dirname, resolve } from 'node:path';
import chalk from 'chalk';
import { Command, Option } from 'clipanion';
import { generateWellKnownIndex, type WellKnownSkill, SkillScanner, formatSummary, Severity } from '@skillkit/core';
function sanitizeSkillName(name: string): string | null {
if (!name || typeof name !== "string") return null;
if (!name || typeof name !== 'string') return null;
const base = basename(name);
if (
base !== name ||
name.includes("..") ||
name.includes("/") ||
name.includes("\\")
) {
if (base !== name || name.includes('..') || name.includes('/') || name.includes('\\')) {
return null;
}
if (!/^[a-zA-Z0-9._-]+$/.test(name)) {
@@ -41,64 +23,11 @@ interface SkillFrontmatter {
version?: string;
}
function parseSkillFrontmatter(content: string): SkillFrontmatter {
const match = content.match(/^---\r?\n([\s\S]*?)\r?\n---/);
if (!match) return {};
const frontmatter: SkillFrontmatter = {};
const lines = match[1].split(/\r?\n/);
let inTagsList = false;
for (const line of lines) {
if (inTagsList) {
const tagMatch = line.match(/^\s*-\s*(.+)$/);
if (tagMatch) {
frontmatter.tags ??= [];
frontmatter.tags.push(tagMatch[1].trim().replace(/^["']|["']$/g, ""));
continue;
}
if (line.trim() === "") continue;
inTagsList = false;
}
const colonIdx = line.indexOf(":");
if (colonIdx === -1) continue;
const key = line.slice(0, colonIdx).trim();
const value = line.slice(colonIdx + 1).trim();
switch (key) {
case "name":
frontmatter.name = value.replace(/^["']|["']$/g, "");
break;
case "description":
frontmatter.description = value.replace(/^["']|["']$/g, "");
break;
case "version":
frontmatter.version = value.replace(/^["']|["']$/g, "");
break;
case "tags":
if (value.startsWith("[")) {
frontmatter.tags = value
.slice(1, -1)
.split(",")
.map((t) => t.trim().replace(/^["']|["']$/g, ""))
.filter((t) => t.length > 0);
} else if (value === "") {
inTagsList = true;
frontmatter.tags = [];
}
break;
}
}
return frontmatter;
}
export class PublishCommand extends Command {
static override paths = [["publish"]];
static override paths = [['publish']];
static override usage = Command.Usage({
description: "Generate well-known skills structure for hosting",
description: 'Generate well-known skills structure for hosting',
details: `
This command generates the RFC 8615 well-known URI structure for hosting skills.
@@ -109,79 +38,59 @@ export class PublishCommand extends Command {
Users can then install skills via: skillkit add https://your-domain.com
`,
examples: [
["Generate from current directory", "$0 publish"],
["Generate from specific path", "$0 publish ./my-skills"],
["Generate to custom output directory", "$0 publish --output ./public"],
["Preview without writing", "$0 publish --dry-run"],
['Generate from current directory', '$0 publish'],
['Generate from specific path', '$0 publish ./my-skills'],
['Generate to custom output directory', '$0 publish --output ./public'],
['Preview without writing', '$0 publish --dry-run'],
],
});
skillPath = Option.String({ required: false, name: "path" });
skillPath = Option.String({ required: false, name: 'path' });
output = Option.String("--output,-o", {
description:
"Output directory for well-known structure (default: current directory)",
output = Option.String('--output,-o', {
description: 'Output directory for well-known structure (default: current directory)',
});
dryRun = Option.Boolean("--dry-run,-n", false, {
description: "Show what would be generated without writing files",
dryRun = Option.Boolean('--dry-run,-n', false, {
description: 'Show what would be generated without writing files',
});
format = Option.String("--format", {
description:
'Output format: "standard" (default) or "mintlify" (.well-known/skills/default/skill.md)',
format = Option.String('--format', {
description: 'Output format: "standard" (default) or "mintlify" (.well-known/skills/default/skill.md)',
});
async execute(): Promise<number> {
const basePath = this.skillPath || process.cwd();
const outputDir = this.output || basePath;
console.log(chalk.cyan("Generating well-known skills structure...\n"));
console.log(chalk.cyan('Generating well-known skills structure...\n'));
const discoveredSkills = this.discoverSkills(basePath);
if (discoveredSkills.length === 0) {
console.error(chalk.red("No skills found"));
console.error(
chalk.dim("Skills must contain a SKILL.md file with frontmatter"),
);
console.error(chalk.red('No skills found'));
console.error(chalk.dim('Skills must contain a SKILL.md file with frontmatter'));
return 1;
}
console.log(chalk.white(`Found ${discoveredSkills.length} skill(s):\n`));
const wellKnownSkills: WellKnownSkill[] = [];
const validSkills: Array<{
name: string;
safeName: string;
description?: string;
path: string;
}> = [];
const validSkills: Array<{ name: string; safeName: string; description?: string; path: string }> = [];
for (const skill of discoveredSkills) {
const safeName = sanitizeSkillName(skill.name);
if (!safeName) {
console.log(
chalk.yellow(
` ${chalk.yellow("⚠")} Skipping "${skill.name}" (invalid name - must be alphanumeric with hyphens/underscores)`,
),
);
console.log(chalk.yellow(` ${chalk.yellow('⚠')} Skipping "${skill.name}" (invalid name - must be alphanumeric with hyphens/underscores)`));
continue;
}
const files = this.getSkillFiles(skill.path);
console.log(chalk.dim(` ${chalk.green("●")} ${safeName}`));
console.log(
chalk.dim(` Description: ${skill.description || "No description"}`),
);
console.log(chalk.dim(` Files: ${files.join(", ")}`));
console.log(chalk.dim(` ${chalk.green('●')} ${safeName}`));
console.log(chalk.dim(` Description: ${skill.description || 'No description'}`));
console.log(chalk.dim(` Files: ${files.join(', ')}`));
validSkills.push({
name: skill.name,
safeName,
description: skill.description,
path: skill.path,
});
validSkills.push({ name: skill.name, safeName, description: skill.description, path: skill.path });
wellKnownSkills.push({
name: safeName,
description: skill.description,
@@ -192,115 +101,78 @@ export class PublishCommand extends Command {
const scanner = new SkillScanner({ failOnSeverity: Severity.HIGH });
for (const skill of validSkills) {
const scanResult = await scanner.scan(skill.path);
if (scanResult.verdict === "fail") {
console.error(
chalk.red(`\nSecurity scan FAILED for "${skill.safeName}"`),
);
if (scanResult.verdict === 'fail') {
console.error(chalk.red(`\nSecurity scan FAILED for "${skill.safeName}"`));
console.error(formatSummary(scanResult));
console.error(chalk.dim("Fix security issues before publishing."));
console.error(chalk.dim('Fix security issues before publishing.'));
return 1;
}
if (scanResult.verdict === "warn") {
console.log(
chalk.yellow(
` Security warnings for "${skill.safeName}" (${scanResult.findings.length} findings)`,
),
);
if (scanResult.verdict === 'warn') {
console.log(chalk.yellow(` Security warnings for "${skill.safeName}" (${scanResult.findings.length} findings)`));
}
}
if (validSkills.length === 0) {
console.error(chalk.red("\nNo valid skills to publish"));
console.error(chalk.red('\nNo valid skills to publish'));
return 1;
}
console.log("");
console.log('');
if (this.format === "mintlify") {
if (this.format === 'mintlify') {
if (this.dryRun) {
console.log(chalk.yellow("Dry run - not writing files\n"));
console.log(chalk.white("Would generate (Mintlify format):"));
console.log(chalk.yellow('Dry run - not writing files\n'));
console.log(chalk.white('Would generate (Mintlify format):'));
for (const skill of validSkills) {
console.log(
chalk.dim(
` ${outputDir}/.well-known/skills/${skill.safeName}/skill.md`,
),
);
console.log(chalk.dim(` ${outputDir}/.well-known/skills/${skill.safeName}/skill.md`));
}
return 0;
}
const resolvedOutput = resolve(outputDir);
for (const skill of validSkills) {
const mintlifyDir = join(
outputDir,
".well-known",
"skills",
skill.safeName,
);
const mintlifyDir = join(outputDir, '.well-known', 'skills', skill.safeName);
const resolvedDir = resolve(mintlifyDir);
if (!resolvedDir.startsWith(resolvedOutput + sep)) {
console.log(
chalk.red(`Skipping ${skill.safeName} (path traversal detected)`),
);
if (!resolvedDir.startsWith(resolvedOutput)) {
console.log(chalk.red(`Skipping ${skill.safeName} (path traversal detected)`));
continue;
}
mkdirSync(mintlifyDir, { recursive: true });
const skillMdPath = join(skill.path, "SKILL.md");
const skillMdPath = join(skill.path, 'SKILL.md');
if (existsSync(skillMdPath)) {
const content = readFileSync(skillMdPath, "utf-8");
writeFileSync(join(mintlifyDir, "skill.md"), content);
const content = readFileSync(skillMdPath, 'utf-8');
writeFileSync(join(mintlifyDir, 'skill.md'), content);
}
}
console.log(chalk.green("Generated Mintlify well-known structure:\n"));
console.log(chalk.green('Generated Mintlify well-known structure:\n'));
for (const skill of validSkills) {
console.log(
chalk.dim(
` ${outputDir}/.well-known/skills/${skill.safeName}/skill.md`,
),
);
console.log(chalk.dim(` ${outputDir}/.well-known/skills/${skill.safeName}/skill.md`));
}
console.log("");
console.log(chalk.cyan("Next steps:"));
console.log(
chalk.dim(" 1. Deploy the .well-known directory to your web server"),
);
console.log(
chalk.dim(
" 2. Users can install via: skillkit install https://your-domain.com",
),
);
console.log(
chalk.dim(
" 3. Skills auto-discovered from /.well-known/skills/{name}/skill.md",
),
);
console.log('');
console.log(chalk.cyan('Next steps:'));
console.log(chalk.dim(' 1. Deploy the .well-known directory to your web server'));
console.log(chalk.dim(' 2. Users can install via: skillkit install https://your-domain.com'));
console.log(chalk.dim(' 3. Skills auto-discovered from /.well-known/skills/{name}/skill.md'));
return 0;
}
if (this.dryRun) {
console.log(chalk.yellow("Dry run - not writing files\n"));
console.log(chalk.white("Would generate:"));
console.log(chalk.yellow('Dry run - not writing files\n'));
console.log(chalk.white('Would generate:'));
console.log(chalk.dim(` ${outputDir}/.well-known/skills/index.json`));
for (const skill of wellKnownSkills) {
for (const file of skill.files) {
console.log(
chalk.dim(
` ${outputDir}/.well-known/skills/${skill.name}/${file}`,
),
);
console.log(chalk.dim(` ${outputDir}/.well-known/skills/${skill.name}/${file}`));
}
}
console.log("");
console.log(chalk.white("index.json preview:"));
console.log(
JSON.stringify(generateWellKnownIndex(wellKnownSkills), null, 2),
);
console.log('');
console.log(chalk.white('index.json preview:'));
console.log(JSON.stringify(generateWellKnownIndex(wellKnownSkills), null, 2));
return 0;
}
const wellKnownDir = join(outputDir, ".well-known", "skills");
const wellKnownDir = join(outputDir, '.well-known', 'skills');
mkdirSync(wellKnownDir, { recursive: true });
for (const skill of validSkills) {
@@ -308,10 +180,8 @@ export class PublishCommand extends Command {
const resolvedSkillDir = resolve(skillDir);
const resolvedWellKnownDir = resolve(wellKnownDir);
if (!resolvedSkillDir.startsWith(resolvedWellKnownDir + sep)) {
console.log(
chalk.yellow(` Skipping "${skill.name}" (path traversal detected)`),
);
if (!resolvedSkillDir.startsWith(resolvedWellKnownDir)) {
console.log(chalk.yellow(` Skipping "${skill.name}" (path traversal detected)`));
continue;
}
@@ -322,51 +192,35 @@ export class PublishCommand extends Command {
const safeFile = basename(file);
const sourcePath = join(skill.path, file);
const destPath = join(skillDir, safeFile);
const content = readFileSync(sourcePath, "utf-8");
const content = readFileSync(sourcePath, 'utf-8');
writeFileSync(destPath, content);
}
}
const index = generateWellKnownIndex(wellKnownSkills);
writeFileSync(
join(wellKnownDir, "index.json"),
JSON.stringify(index, null, 2),
);
writeFileSync(join(wellKnownDir, 'index.json'), JSON.stringify(index, null, 2));
console.log(chalk.green("Generated well-known structure:\n"));
console.log(chalk.green('Generated well-known structure:\n'));
console.log(chalk.dim(` ${wellKnownDir}/index.json`));
for (const skill of wellKnownSkills) {
console.log(chalk.dim(` ${wellKnownDir}/${skill.name}/`));
}
console.log("");
console.log(chalk.cyan("Next steps:"));
console.log(
chalk.dim(" 1. Deploy the .well-known directory to your web server"),
);
console.log(
chalk.dim(
" 2. Users can install via: skillkit add https://your-domain.com",
),
);
console.log(
chalk.dim(
" 3. Skills auto-discovered from /.well-known/skills/index.json",
),
);
console.log('');
console.log(chalk.cyan('Next steps:'));
console.log(chalk.dim(' 1. Deploy the .well-known directory to your web server'));
console.log(chalk.dim(' 2. Users can install via: skillkit add https://your-domain.com'));
console.log(chalk.dim(' 3. Skills auto-discovered from /.well-known/skills/index.json'));
return 0;
}
private discoverSkills(
basePath: string,
): Array<{ name: string; description?: string; path: string }> {
const skills: Array<{ name: string; description?: string; path: string }> =
[];
private discoverSkills(basePath: string): Array<{ name: string; description?: string; path: string }> {
const skills: Array<{ name: string; description?: string; path: string }> = [];
const skillMdPath = join(basePath, "SKILL.md");
const skillMdPath = join(basePath, 'SKILL.md');
if (existsSync(skillMdPath)) {
const content = readFileSync(skillMdPath, "utf-8");
const content = readFileSync(skillMdPath, 'utf-8');
const frontmatter = this.parseFrontmatter(content);
skills.push({
name: frontmatter.name || basename(basePath),
@@ -378,8 +232,8 @@ export class PublishCommand extends Command {
const searchDirs = [
basePath,
join(basePath, "skills"),
join(basePath, ".claude", "skills"),
join(basePath, 'skills'),
join(basePath, '.claude', 'skills'),
];
for (const searchDir of searchDirs) {
@@ -390,9 +244,9 @@ export class PublishCommand extends Command {
const entryPath = join(searchDir, entry);
if (!statSync(entryPath).isDirectory()) continue;
const entrySkillMd = join(entryPath, "SKILL.md");
const entrySkillMd = join(entryPath, 'SKILL.md');
if (existsSync(entrySkillMd)) {
const content = readFileSync(entrySkillMd, "utf-8");
const content = readFileSync(entrySkillMd, 'utf-8');
const frontmatter = this.parseFrontmatter(content);
skills.push({
name: frontmatter.name || entry,
@@ -413,42 +267,92 @@ export class PublishCommand extends Command {
for (const entry of entries) {
const entryPath = join(skillPath, entry);
if (statSync(entryPath).isFile()) {
if (entry.startsWith(".")) continue;
if (entry.startsWith('.') || entry === '.skillkit-metadata.json') continue;
files.push(entry);
}
}
if (!files.includes("SKILL.md")) {
files.unshift("SKILL.md");
if (!files.includes('SKILL.md')) {
files.unshift('SKILL.md');
}
return files;
}
private parseFrontmatter(content: string): SkillFrontmatter {
return parseSkillFrontmatter(content);
const match = content.match(/^---\r?\n([\s\S]*?)\r?\n---/);
if (!match) return {};
const frontmatter: SkillFrontmatter = {};
const lines = match[1].split(/\r?\n/);
let inTagsList = false;
for (const line of lines) {
if (inTagsList) {
const tagMatch = line.match(/^\s*-\s*(.+)$/);
if (tagMatch) {
frontmatter.tags ??= [];
frontmatter.tags.push(tagMatch[1].trim().replace(/^["']|["']$/g, ''));
continue;
}
if (line.trim() === '') continue;
inTagsList = false;
}
const colonIdx = line.indexOf(':');
if (colonIdx === -1) continue;
const key = line.slice(0, colonIdx).trim();
const value = line.slice(colonIdx + 1).trim();
switch (key) {
case 'name':
frontmatter.name = value.replace(/^["']|["']$/g, '');
break;
case 'description':
frontmatter.description = value.replace(/^["']|["']$/g, '');
break;
case 'version':
frontmatter.version = value.replace(/^["']|["']$/g, '');
break;
case 'tags':
if (value.startsWith('[')) {
frontmatter.tags = value
.slice(1, -1)
.split(',')
.map(t => t.trim().replace(/^["']|["']$/g, ''))
.filter(t => t.length > 0);
} else if (value === '') {
inTagsList = true;
frontmatter.tags = [];
}
break;
}
}
return frontmatter;
}
}
export class PublishSubmitCommand extends Command {
static override paths = [["publish", "submit"]];
static override paths = [['publish', 'submit']];
static override usage = Command.Usage({
description: "Submit skill to SkillKit marketplace (requires review)",
description: 'Submit skill to SkillKit marketplace (requires review)',
examples: [
["Submit skill from current directory", "$0 publish submit"],
["Submit with custom name", "$0 publish submit --name my-skill"],
['Submit skill from current directory', '$0 publish submit'],
['Submit with custom name', '$0 publish submit --name my-skill'],
],
});
skillPath = Option.String({ required: false, name: "path" });
skillPath = Option.String({ required: false, name: 'path' });
name = Option.String("--name,-n", {
description: "Custom skill name",
name = Option.String('--name,-n', {
description: 'Custom skill name',
});
dryRun = Option.Boolean("--dry-run", false, {
description: "Show what would be submitted",
dryRun = Option.Boolean('--dry-run', false, {
description: 'Show what would be submitted',
});
async execute(): Promise<number> {
@@ -456,58 +360,49 @@ export class PublishSubmitCommand extends Command {
const skillMdPath = this.findSkillMd(skillPath);
if (!skillMdPath) {
console.error(chalk.red("No SKILL.md found"));
console.error(
chalk.dim("Run this command from a directory containing SKILL.md"),
);
console.error(chalk.red('No SKILL.md found'));
console.error(chalk.dim('Run this command from a directory containing SKILL.md'));
return 1;
}
console.log(chalk.cyan("Submitting skill to SkillKit marketplace...\n"));
console.log(chalk.cyan('Submitting skill to SkillKit marketplace...\n'));
const content = readFileSync(skillMdPath, "utf-8");
const content = readFileSync(skillMdPath, 'utf-8');
const frontmatter = this.parseFrontmatter(content);
const skillName =
this.name || frontmatter.name || basename(dirname(skillMdPath));
const skillName = this.name || frontmatter.name || basename(dirname(skillMdPath));
const repoInfo = await this.getRepoInfo(dirname(skillMdPath));
const repoInfo = this.getRepoInfo(dirname(skillMdPath));
if (!repoInfo) {
console.error(chalk.red("Not a git repository or no remote configured"));
console.error(
chalk.dim(
"Your skill must be in a git repository with a GitHub remote",
),
);
console.error(chalk.red('Not a git repository or no remote configured'));
console.error(chalk.dim('Your skill must be in a git repository with a GitHub remote'));
return 1;
}
const skillSlug = this.slugify(skillName);
if (!skillSlug) {
console.error(chalk.red("Skill name produces an empty slug."));
console.error(chalk.dim("Please pass --name with letters or numbers."));
console.error(chalk.red('Skill name produces an empty slug.'));
console.error(chalk.dim('Please pass --name with letters or numbers.'));
return 1;
}
const skillEntry = {
id: `${repoInfo.owner}/${repoInfo.repo}/${skillSlug}`,
name: this.formatName(skillName),
description:
frontmatter.description ||
`Best practices for ${this.formatName(skillName)}`,
description: frontmatter.description || `Best practices for ${this.formatName(skillName)}`,
source: `${repoInfo.owner}/${repoInfo.repo}`,
tags: frontmatter.tags || ["general"],
tags: frontmatter.tags || ['general'],
};
console.log(chalk.white("Skill details:"));
console.log(chalk.white('Skill details:'));
console.log(chalk.dim(` ID: ${skillEntry.id}`));
console.log(chalk.dim(` Name: ${skillEntry.name}`));
console.log(chalk.dim(` Description: ${skillEntry.description}`));
console.log(chalk.dim(` Source: ${skillEntry.source}`));
console.log(chalk.dim(` Tags: ${skillEntry.tags.join(", ")}`));
console.log(chalk.dim(` Tags: ${skillEntry.tags.join(', ')}`));
console.log();
if (this.dryRun) {
console.log(chalk.yellow("Dry run - not submitting"));
console.log(chalk.yellow('Dry run - not submitting'));
console.log(JSON.stringify(skillEntry, null, 2));
return 0;
}
@@ -517,27 +412,23 @@ export class PublishSubmitCommand extends Command {
const issueBodyEncoded = encodeURIComponent(issueBody);
const issueUrl = `https://github.com/rohitg00/skillkit/issues/new?title=${issueTitle}&body=${issueBodyEncoded}&labels=skill-submission,publish`;
console.log(chalk.green("Opening GitHub to submit your skill...\n"));
console.log(chalk.green('Opening GitHub to submit your skill...\n'));
try {
const { execFileSync } = await import("node:child_process");
const cmd =
process.platform === "darwin"
? "open"
: process.platform === "win32"
? "cmd"
: "xdg-open";
const args =
process.platform === "win32"
? ["/c", "start", "", issueUrl]
: [issueUrl];
execFileSync(cmd, args, { stdio: "ignore" });
const { execSync } = await import('node:child_process');
const openCmd =
process.platform === 'darwin'
? `open "${issueUrl}"`
: process.platform === 'win32'
? `cmd /c start "" "${issueUrl}"`
: `xdg-open "${issueUrl}"`;
execSync(openCmd, { stdio: 'ignore' });
console.log(chalk.green("GitHub issue page opened!"));
console.log(chalk.dim("Review and submit the issue."));
console.log(chalk.green('GitHub issue page opened!'));
console.log(chalk.dim('Review and submit the issue.'));
} catch {
console.log(chalk.yellow("Could not open browser automatically."));
console.log(chalk.dim("Please open this URL manually:\n"));
console.log(chalk.yellow('Could not open browser automatically.'));
console.log(chalk.dim('Please open this URL manually:\n'));
console.log(chalk.cyan(issueUrl));
}
@@ -545,18 +436,18 @@ export class PublishSubmitCommand extends Command {
}
private findSkillMd(basePath: string): string | null {
if (basePath.endsWith("SKILL.md") && existsSync(basePath)) {
if (basePath.endsWith('SKILL.md') && existsSync(basePath)) {
return basePath;
}
const direct = join(basePath, "SKILL.md");
const direct = join(basePath, 'SKILL.md');
if (existsSync(direct)) {
return direct;
}
const locations = [
join(basePath, "skills", "SKILL.md"),
join(basePath, ".claude", "skills", "SKILL.md"),
join(basePath, 'skills', 'SKILL.md'),
join(basePath, '.claude', 'skills', 'SKILL.md'),
];
for (const loc of locations) {
@@ -569,26 +460,59 @@ export class PublishSubmitCommand extends Command {
}
private parseFrontmatter(content: string): SkillFrontmatter {
return parseSkillFrontmatter(content);
const match = content.match(/^---\r?\n([\s\S]*?)\r?\n---/);
if (!match) return {};
const frontmatter: SkillFrontmatter = {};
const lines = match[1].split(/\r?\n/);
for (const line of lines) {
const colonIdx = line.indexOf(':');
if (colonIdx === -1) continue;
const key = line.slice(0, colonIdx).trim();
const value = line.slice(colonIdx + 1).trim();
switch (key) {
case 'name':
frontmatter.name = value.replace(/^["']|["']$/g, '');
break;
case 'description':
frontmatter.description = value.replace(/^["']|["']$/g, '');
break;
case 'version':
frontmatter.version = value.replace(/^["']|["']$/g, '');
break;
case 'tags':
if (value.startsWith('[')) {
frontmatter.tags = value
.slice(1, -1)
.split(',')
.map(t => t.trim().replace(/^["']|["']$/g, ''))
.filter(t => t.length > 0);
}
break;
}
}
return frontmatter;
}
private slugify(name: string): string {
return name
.toLowerCase()
.trim()
.replace(/[^a-z0-9]+/g, "-")
.replace(/^-+|-+$/g, "");
.replace(/[^a-z0-9]+/g, '-')
.replace(/^-+|-+$/g, '');
}
private async getRepoInfo(
dir: string,
): Promise<{ owner: string; repo: string } | null> {
private getRepoInfo(dir: string): { owner: string; repo: string } | null {
try {
const { execFileSync } = await import("node:child_process");
const remote = execFileSync("git", ["remote", "get-url", "origin"], {
const { execSync } = require('node:child_process');
const remote = execSync('git remote get-url origin', {
cwd: dir,
encoding: "utf-8",
stdio: ["pipe", "pipe", "ignore"],
encoding: 'utf-8',
stdio: ['pipe', 'pipe', 'ignore'],
}).trim();
const match = remote.match(/github\.com[:/]([^/]+)\/(.+?)(?:\.git)?$/);
@@ -605,17 +529,13 @@ export class PublishSubmitCommand extends Command {
private formatName(name: string): string {
return name
.split(/[-_]/)
.map((word) => word.charAt(0).toUpperCase() + word.slice(1))
.join(" ");
.map(word => word.charAt(0).toUpperCase() + word.slice(1))
.join(' ');
}
private createIssueBody(skill: {
id: string;
name: string;
description: string;
source: string;
tags: string[];
}): string {
private createIssueBody(
skill: { id: string; name: string; description: string; source: string; tags: string[] }
): string {
return `## Publish Skill Request
### Skill Details
@@ -623,7 +543,7 @@ export class PublishSubmitCommand extends Command {
- **Name:** ${skill.name}
- **Description:** ${skill.description}
- **Source:** [${skill.source}](https://github.com/${skill.source})
- **Tags:** ${skill.tags.map((t) => `\`${t}\``).join(", ")}
- **Tags:** ${skill.tags.map(t => `\`${t}\``).join(', ')}
### JSON Entry
\`\`\`json
+9 -3
View File
@@ -7,9 +7,9 @@ import {
initProject as coreInitProject,
loadSkillMetadata as coreLoadSkillMetadata,
saveSkillMetadata as coreSaveSkillMetadata,
} from '@skillkit/core';
import { getAdapter, detectAgent } from '@skillkit/agents';
import type { AgentType, AgentAdapterInfo } from '@skillkit/core';
} from "@skillkit/core";
import { getAdapter, detectAgent } from "@skillkit/agents";
import type { AgentType, AgentAdapterInfo } from "@skillkit/core";
// Re-export metadata functions directly (they don't need adapter bridging)
export const loadSkillMetadata = coreLoadSkillMetadata;
@@ -62,3 +62,9 @@ export async function initProject(agentType?: AgentType): Promise<void> {
};
return coreInitProject(type, adapterInfo);
}
export function formatCount(count: number): string {
if (count >= 1_000_000) return `${(count / 1_000_000).toFixed(1)}M`;
if (count >= 1_000) return `${(count / 1_000).toFixed(1)}K`;
return String(count);
}
+74 -109
View File
@@ -4,9 +4,8 @@
* Executes skills with task-based orchestration, verification, and state management.
*/
import { execFileSync } from "node:child_process";
import { randomUUID } from "node:crypto";
import { splitCommand } from "../utils/shell.js";
import { execSync } from 'node:child_process';
import { randomUUID } from 'node:crypto';
import type {
ExecutableSkill,
ExecutableTask,
@@ -16,25 +15,20 @@ import type {
CheckpointHandler,
CheckpointResponse,
ExecutionTaskStatus,
} from "./types.js";
import { SessionManager } from "../session/manager.js";
import type { SessionTask } from "../session/types.js";
} from './types.js';
import { SessionManager } from '../session/manager.js';
import type { SessionTask } from '../session/types.js';
/**
* Progress event for execution
*/
export interface ExecutionProgressEvent {
type:
| "task_start"
| "task_complete"
| "checkpoint"
| "verification"
| "complete";
type: 'task_start' | 'task_complete' | 'checkpoint' | 'verification' | 'complete';
taskId?: string;
taskName?: string;
taskIndex?: number;
totalTasks?: number;
status?: ExecutionTaskStatus | "paused" | "cancelled";
status?: ExecutionTaskStatus | 'paused' | 'cancelled';
message?: string;
error?: string;
}
@@ -58,7 +52,7 @@ export class SkillExecutionEngine {
options?: {
checkpointHandler?: CheckpointHandler;
onProgress?: ExecutionProgressCallback;
},
}
) {
this.projectPath = projectPath;
this.sessionManager = new SessionManager(projectPath);
@@ -71,7 +65,7 @@ export class SkillExecutionEngine {
*/
async execute(
skill: ExecutableSkill,
options: ExecutionOptions = {},
options: ExecutionOptions = {}
): Promise<SkillExecutionResult> {
const startTime = new Date();
const tasks = skill.tasks || [];
@@ -84,26 +78,23 @@ export class SkillExecutionEngine {
// Check if there's an existing paused execution for this skill
const existingState = this.sessionManager.get();
if (existingState?.currentExecution?.skillName === skill.name) {
if (existingState.currentExecution.status === "paused") {
if (existingState.currentExecution.status === 'paused') {
// Resume from paused state
return this.resumeExecution(skill, options);
}
}
// Start new execution
const sessionTasks: Omit<SessionTask, "status">[] = tasks.map(
(task, index) => ({
id: task.id || `task-${index}`,
name: task.name,
type: task.type === "auto" ? "auto" : task.type,
}),
);
const sessionTasks: Omit<SessionTask, 'status'>[] = tasks.map((task, index) => ({
id: task.id || `task-${index}`,
name: task.name,
type: task.type === 'auto' ? 'auto' : task.type,
}));
this.sessionManager.startExecution(skill.name, skill.source, sessionTasks);
const taskResults: TaskExecutionResult[] = [];
let overallStatus: "completed" | "failed" | "cancelled" | "paused" =
"completed";
let overallStatus: 'completed' | 'failed' | 'cancelled' | 'paused' = 'completed';
let overallError: string | undefined;
// Execute tasks
@@ -111,7 +102,7 @@ export class SkillExecutionEngine {
const task = tasks[i];
this.onProgress?.({
type: "task_start",
type: 'task_start',
taskId: task.id,
taskName: task.name,
taskIndex: i,
@@ -119,7 +110,7 @@ export class SkillExecutionEngine {
});
// Handle checkpoints
if (task.type !== "auto") {
if (task.type !== 'auto') {
const checkpointResult = await this.handleCheckpoint(task, {
skillName: skill.name,
taskIndex: i,
@@ -127,20 +118,17 @@ export class SkillExecutionEngine {
});
if (!checkpointResult.continue) {
overallStatus = "paused";
overallStatus = 'paused';
this.sessionManager.pause();
break;
}
// For decision checkpoints, record the decision
if (
task.type === "checkpoint:decision" &&
checkpointResult.selectedOption
) {
if (task.type === 'checkpoint:decision' && checkpointResult.selectedOption) {
this.sessionManager.recordDecision(
`${skill.name}:${task.id}`,
checkpointResult.selectedOption,
skill.name,
skill.name
);
}
}
@@ -150,7 +138,7 @@ export class SkillExecutionEngine {
taskResults.push(taskResult);
this.sessionManager.updateTask(task.id || `task-${i}`, {
status: taskResult.status === "completed" ? "completed" : "failed",
status: taskResult.status === 'completed' ? 'completed' : 'failed',
output: taskResult.output,
error: taskResult.error,
filesModified: taskResult.filesModified,
@@ -158,7 +146,7 @@ export class SkillExecutionEngine {
});
this.onProgress?.({
type: "task_complete",
type: 'task_complete',
taskId: task.id,
taskName: task.name,
taskIndex: i,
@@ -168,9 +156,9 @@ export class SkillExecutionEngine {
});
// Handle task failure
if (taskResult.status === "failed") {
if (taskResult.status === 'failed') {
if (!options.continueOnError) {
overallStatus = "failed";
overallStatus = 'failed';
overallError = taskResult.error;
break;
}
@@ -180,8 +168,8 @@ export class SkillExecutionEngine {
if (options.verify && task.verify) {
const verificationPassed = await this.runVerification(task, taskResult);
if (!verificationPassed && !options.continueOnError) {
overallStatus = "failed";
overallError = "Verification failed";
overallStatus = 'failed';
overallError = 'Verification failed';
break;
}
}
@@ -190,7 +178,7 @@ export class SkillExecutionEngine {
const endTime = new Date();
// Complete the execution
if (overallStatus !== "paused") {
if (overallStatus !== 'paused') {
this.sessionManager.completeExecution(overallStatus, overallError);
}
@@ -202,27 +190,20 @@ export class SkillExecutionEngine {
completedAt: endTime.toISOString(),
durationMs: endTime.getTime() - startTime.getTime(),
tasks: taskResults,
filesModified: Array.from(
new Set(taskResults.flatMap((t) => t.filesModified || [])),
),
commits: taskResults
.map((t) => t.commitSha)
.filter((sha): sha is string => !!sha),
filesModified: Array.from(new Set(taskResults.flatMap((t) => t.filesModified || []))),
commits: taskResults.map((t) => t.commitSha).filter((sha): sha is string => !!sha),
error: overallError,
};
const statusMessages: Record<
"completed" | "failed" | "cancelled" | "paused",
string
> = {
completed: "Skill execution completed",
paused: "Skill execution paused",
failed: overallError || "Skill execution failed",
cancelled: "Skill execution cancelled",
const statusMessages: Record<'completed' | 'failed' | 'cancelled' | 'paused', string> = {
completed: 'Skill execution completed',
paused: 'Skill execution paused',
failed: overallError || 'Skill execution failed',
cancelled: 'Skill execution cancelled',
};
this.onProgress?.({
type: "complete",
type: 'complete',
status: overallStatus,
message: statusMessages[overallStatus],
});
@@ -235,11 +216,11 @@ export class SkillExecutionEngine {
*/
private async resumeExecution(
skill: ExecutableSkill,
options: ExecutionOptions,
options: ExecutionOptions
): Promise<SkillExecutionResult> {
const state = this.sessionManager.get();
if (!state?.currentExecution) {
throw new Error("No execution to resume");
throw new Error('No execution to resume');
}
this.sessionManager.resume();
@@ -247,8 +228,7 @@ export class SkillExecutionEngine {
const tasks = skill.tasks || [];
const taskResults: TaskExecutionResult[] = [];
let overallStatus: "completed" | "failed" | "cancelled" | "paused" =
"completed";
let overallStatus: 'completed' | 'failed' | 'cancelled' | 'paused' = 'completed';
let overallError: string | undefined;
// Find where to resume from
@@ -258,7 +238,7 @@ export class SkillExecutionEngine {
const task = tasks[i];
this.onProgress?.({
type: "task_start",
type: 'task_start',
taskId: task.id,
taskName: task.name,
taskIndex: i,
@@ -266,7 +246,7 @@ export class SkillExecutionEngine {
});
// Handle checkpoints (same as in execute)
if (task.type !== "auto") {
if (task.type !== 'auto') {
const checkpointResult = await this.handleCheckpoint(task, {
skillName: skill.name,
taskIndex: i,
@@ -274,20 +254,17 @@ export class SkillExecutionEngine {
});
if (!checkpointResult.continue) {
overallStatus = "paused";
overallStatus = 'paused';
this.sessionManager.pause();
break;
}
// For decision checkpoints, record the decision
if (
task.type === "checkpoint:decision" &&
checkpointResult.selectedOption
) {
if (task.type === 'checkpoint:decision' && checkpointResult.selectedOption) {
this.sessionManager.recordDecision(
`${skill.name}:${task.id}`,
checkpointResult.selectedOption,
skill.name,
skill.name
);
}
}
@@ -296,7 +273,7 @@ export class SkillExecutionEngine {
taskResults.push(taskResult);
this.sessionManager.updateTask(task.id || `task-${i}`, {
status: taskResult.status === "completed" ? "completed" : "failed",
status: taskResult.status === 'completed' ? 'completed' : 'failed',
output: taskResult.output,
error: taskResult.error,
filesModified: taskResult.filesModified,
@@ -305,7 +282,7 @@ export class SkillExecutionEngine {
// Emit task_complete progress event (matching execute behavior)
this.onProgress?.({
type: "task_complete",
type: 'task_complete',
taskId: task.id,
taskName: task.name,
taskIndex: i,
@@ -315,9 +292,9 @@ export class SkillExecutionEngine {
});
// Handle task failure
if (taskResult.status === "failed") {
if (taskResult.status === 'failed') {
if (!options.continueOnError) {
overallStatus = "failed";
overallStatus = 'failed';
overallError = taskResult.error;
break;
}
@@ -327,15 +304,15 @@ export class SkillExecutionEngine {
if (options.verify && task.verify) {
const verificationPassed = await this.runVerification(task, taskResult);
if (!verificationPassed && !options.continueOnError) {
overallStatus = "failed";
overallError = "Verification failed";
overallStatus = 'failed';
overallError = 'Verification failed';
break;
}
}
}
// Only complete execution if not paused
if (overallStatus !== "paused") {
if (overallStatus !== 'paused') {
this.sessionManager.completeExecution(overallStatus, overallError);
}
@@ -347,12 +324,8 @@ export class SkillExecutionEngine {
completedAt: new Date().toISOString(),
durationMs: Date.now() - new Date(execution.startedAt).getTime(),
tasks: taskResults,
filesModified: Array.from(
new Set(taskResults.flatMap((t) => t.filesModified || [])),
),
commits: taskResults
.map((t) => t.commitSha)
.filter((sha): sha is string => !!sha),
filesModified: Array.from(new Set(taskResults.flatMap((t) => t.filesModified || []))),
commits: taskResults.map((t) => t.commitSha).filter((sha): sha is string => !!sha),
error: overallError,
};
}
@@ -363,7 +336,7 @@ export class SkillExecutionEngine {
private async executeTask(
task: ExecutableTask,
_skill: ExecutableSkill,
_options: ExecutionOptions,
_options: ExecutionOptions
): Promise<TaskExecutionResult> {
const startTime = new Date();
const taskId = task.id || randomUUID();
@@ -381,7 +354,7 @@ export class SkillExecutionEngine {
return {
taskId,
taskName: task.name,
status: "completed",
status: 'completed',
startedAt: startTime.toISOString(),
completedAt: endTime.toISOString(),
durationMs: endTime.getTime() - startTime.getTime(),
@@ -394,7 +367,7 @@ export class SkillExecutionEngine {
return {
taskId,
taskName: task.name,
status: "failed",
status: 'failed',
startedAt: startTime.toISOString(),
completedAt: endTime.toISOString(),
durationMs: endTime.getTime() - startTime.getTime(),
@@ -408,10 +381,10 @@ export class SkillExecutionEngine {
*/
private async handleCheckpoint(
task: ExecutableTask,
context: { skillName: string; taskIndex: number; totalTasks: number },
context: { skillName: string; taskIndex: number; totalTasks: number }
): Promise<CheckpointResponse> {
this.onProgress?.({
type: "checkpoint",
type: 'checkpoint',
taskId: task.id,
taskName: task.name,
taskIndex: context.taskIndex,
@@ -424,7 +397,7 @@ export class SkillExecutionEngine {
}
// Default: auto-continue for non-decision checkpoints
if (task.type === "checkpoint:decision") {
if (task.type === 'checkpoint:decision') {
// Use first option if no handler
return {
continue: true,
@@ -474,11 +447,7 @@ export class SkillExecutionEngine {
* This method validates patterns before execution to prevent catastrophic backtracking.
* Note: This cannot guarantee protection against all ReDoS patterns, but catches common ones.
*/
private safeRegexTest(
pattern: string,
input: string,
_timeoutMs = 1000,
): boolean {
private safeRegexTest(pattern: string, input: string, _timeoutMs = 1000): boolean {
// Strict length limits to prevent excessive processing
if (pattern.length > 200 || input.length > 50000) {
console.warn(`Regex test skipped: pattern or input too long`);
@@ -487,9 +456,7 @@ export class SkillExecutionEngine {
// Reject patterns known to cause ReDoS
if (this.isUnsafeRegexPattern(pattern)) {
console.warn(
`Regex pattern rejected as potentially unsafe: ${pattern.slice(0, 50)}...`,
);
console.warn(`Regex pattern rejected as potentially unsafe: ${pattern.slice(0, 50)}...`);
return false;
}
@@ -511,7 +478,7 @@ export class SkillExecutionEngine {
*/
private async runVerification(
task: ExecutableTask,
result: TaskExecutionResult,
result: TaskExecutionResult
): Promise<boolean> {
if (!task.verify) {
return true;
@@ -527,23 +494,21 @@ export class SkillExecutionEngine {
for (const rule of task.verify.automated) {
if (rule.command) {
try {
const cmdParts = splitCommand(rule.command);
if (cmdParts.length === 0) return false;
const [cmd, ...sanitizedArgs] = cmdParts;
const output = execFileSync(cmd, sanitizedArgs, {
// SECURITY: Commands are from skill config - only run trusted skills
const output = execSync(rule.command, {
cwd: this.projectPath,
encoding: "utf-8",
encoding: 'utf-8',
timeout: 30000,
});
let passed = true;
if (rule.expect) {
if (rule.expect === "success") {
if (rule.expect === 'success') {
passed = true;
} else if (rule.expect.startsWith("contains:")) {
} else if (rule.expect.startsWith('contains:')) {
const expected = rule.expect.slice(9);
passed = output.includes(expected);
} else if (rule.expect.startsWith("matches:")) {
} else if (rule.expect.startsWith('matches:')) {
const pattern = rule.expect.slice(8);
// Use safe regex test to prevent ReDoS
passed = this.safeRegexTest(pattern, output);
@@ -557,10 +522,10 @@ export class SkillExecutionEngine {
});
this.onProgress?.({
type: "verification",
type: 'verification',
taskId: task.id,
taskName: task.name,
message: `Verification ${passed ? "passed" : "failed"}: ${rule.command}`,
message: `Verification ${passed ? 'passed' : 'failed'}: ${rule.command}`,
});
if (!passed) {
@@ -592,18 +557,18 @@ export class SkillExecutionEngine {
return {
skillName: skill.name,
skillSource: skill.source,
status: "completed",
status: 'completed',
startedAt: new Date().toISOString(),
completedAt: new Date().toISOString(),
durationMs: 0,
tasks: tasks.map((task) => ({
taskId: task.id || randomUUID(),
taskName: task.name,
status: "skipped" as ExecutionTaskStatus,
status: 'skipped' as ExecutionTaskStatus,
startedAt: new Date().toISOString(),
completedAt: new Date().toISOString(),
durationMs: 0,
output: "[Dry run - not executed]",
output: '[Dry run - not executed]',
})),
filesModified: [],
commits: [],
@@ -640,7 +605,7 @@ export function createExecutionEngine(
options?: {
checkpointHandler?: CheckpointHandler;
onProgress?: ExecutionProgressCallback;
},
}
): SkillExecutionEngine {
return new SkillExecutionEngine(projectPath, options);
}
-3
View File
@@ -132,6 +132,3 @@ export * from './agents-md/index.js';
// Save (Content Extraction & Skill Generation)
export * from './save/index.js';
// Utilities
export { splitCommand } from './utils/shell.js';
+50 -117
View File
@@ -13,9 +13,7 @@ import type {
PlanExecutionResult,
PlanEvent,
PlanEventListener,
} from "./types.js";
import { execFileSync } from "node:child_process";
import { splitCommand } from "../utils/shell.js";
} from './types.js';
/**
* Step executor function type
@@ -23,7 +21,7 @@ import { splitCommand } from "../utils/shell.js";
export type StepExecutor = (
step: TaskStep,
task: PlanTask,
plan: StructuredPlan,
plan: StructuredPlan
) => Promise<{ success: boolean; output: string; error?: string }>;
/**
@@ -51,10 +49,7 @@ export class PlanExecutor {
/**
* Execute a plan
*/
async execute(
plan: StructuredPlan,
options?: PlanExecutionOptions,
): Promise<PlanExecutionResult> {
async execute(plan: StructuredPlan, options?: PlanExecutionOptions): Promise<PlanExecutionResult> {
const startTime = Date.now();
let aborted = false;
const result: PlanExecutionResult = {
@@ -71,8 +66,8 @@ export class PlanExecutor {
this.isPaused = false;
// Update plan status
plan.status = "executing";
this.emit("plan:execution_started", plan);
plan.status = 'executing';
this.emit('plan:execution_started', plan);
try {
// Build dependency graph
@@ -87,7 +82,7 @@ export class PlanExecutor {
if (this.abortController.signal.aborted) {
aborted = true;
result.success = false;
result.errors = [...(result.errors ?? []), "Execution cancelled"];
result.errors = [...(result.errors ?? []), 'Execution cancelled'];
break;
}
@@ -98,7 +93,7 @@ export class PlanExecutor {
if (this.abortController.signal.aborted) {
aborted = true;
result.success = false;
result.errors = [...(result.errors ?? []), "Execution cancelled"];
result.errors = [...(result.errors ?? []), 'Execution cancelled'];
break;
}
@@ -108,7 +103,7 @@ export class PlanExecutor {
// Check if dependencies completed
const depsCompleted = this.checkDependencies(task, result);
if (!depsCompleted) {
task.status = "skipped";
task.status = 'skipped';
result.skippedTasks.push(taskId);
continue;
}
@@ -118,27 +113,23 @@ export class PlanExecutor {
result.taskResults.set(taskId, taskResult);
if (taskResult.success) {
task.status = "completed";
task.status = 'completed';
task.result = taskResult;
result.completedTasks.push(taskId);
this.emit("plan:task_completed", plan, task, taskResult);
this.emit('plan:task_completed', plan, task, taskResult);
} else {
task.status = "failed";
task.status = 'failed';
task.result = taskResult;
result.failedTasks.push(taskId);
result.success = false;
this.emit("plan:task_failed", plan, task, taskResult);
this.emit('plan:task_failed', plan, task, taskResult);
if (options?.stopOnError) {
// Mark remaining tasks as skipped
for (const remainingId of executionOrder.slice(
executionOrder.indexOf(taskId) + 1,
)) {
const remainingTask = plan.tasks.find(
(t) => t.id === remainingId,
);
for (const remainingId of executionOrder.slice(executionOrder.indexOf(taskId) + 1)) {
const remainingTask = plan.tasks.find((t) => t.id === remainingId);
if (remainingTask) {
remainingTask.status = "skipped";
remainingTask.status = 'skipped';
result.skippedTasks.push(remainingId);
}
}
@@ -148,32 +139,28 @@ export class PlanExecutor {
}
// Update plan status
plan.status = aborted
? "cancelled"
: result.success
? "completed"
: "failed";
plan.status = aborted ? 'cancelled' : result.success ? 'completed' : 'failed';
plan.updatedAt = new Date();
result.durationMs = Date.now() - startTime;
// Emit appropriate event
if (aborted) {
this.emit("plan:execution_cancelled", plan);
this.emit('plan:execution_cancelled', plan);
} else if (result.success) {
this.emit("plan:execution_completed", plan);
this.emit('plan:execution_completed', plan);
} else {
this.emit("plan:execution_failed", plan);
this.emit('plan:execution_failed', plan);
}
return result;
} catch (error) {
plan.status = "failed";
plan.status = 'failed';
result.success = false;
result.durationMs = Date.now() - startTime;
result.errors = [(error as Error).message];
this.emit("plan:execution_failed", plan);
this.emit('plan:execution_failed', plan);
return result;
} finally {
// Reset executor state
@@ -190,18 +177,18 @@ export class PlanExecutor {
private async executeTask(
task: PlanTask,
plan: StructuredPlan,
options?: PlanExecutionOptions,
options?: PlanExecutionOptions
): Promise<PlanTaskResult> {
const startTime = Date.now();
const errors: string[] = [];
const filesCreated: string[] = [];
const filesModified: string[] = [];
task.status = "in_progress";
this.emit("plan:task_started", plan, task);
task.status = 'in_progress';
this.emit('plan:task_started', plan, task);
// Report progress
options?.onProgress?.(task.id, 0, "starting");
options?.onProgress?.(task.id, 0, 'starting');
// Execute steps
for (let i = 0; i < task.steps.length; i++) {
@@ -209,7 +196,7 @@ export class PlanExecutor {
// Check if aborted
if (this.abortController?.signal.aborted) {
errors.push("Execution aborted");
errors.push('Execution aborted');
break;
}
@@ -218,23 +205,17 @@ export class PlanExecutor {
// Re-check if aborted after resuming from pause
if (this.abortController?.signal.aborted) {
errors.push("Execution aborted");
errors.push('Execution aborted');
break;
}
// Report progress
options?.onProgress?.(
task.id,
step.number,
`executing step ${step.number}`,
);
options?.onProgress?.(task.id, step.number, `executing step ${step.number}`);
// Execute step
if (options?.dryRun) {
// Dry run - just log
console.log(
`[DRY RUN] Task ${task.id}, Step ${step.number}: ${step.description}`,
);
console.log(`[DRY RUN] Task ${task.id}, Step ${step.number}: ${step.description}`);
if (step.command) {
console.log(` Command: ${step.command}`);
}
@@ -245,11 +226,11 @@ export class PlanExecutor {
try {
const stepResult = await this.executeWithTimeout(
this.stepExecutor(step, task, plan),
options?.taskTimeout || 60000,
options?.taskTimeout || 60000
);
if (!stepResult.success) {
errors.push(`Step ${step.number}: ${stepResult.error || "Failed"}`);
errors.push(`Step ${step.number}: ${stepResult.error || 'Failed'}`);
if (step.critical) {
break;
@@ -264,7 +245,7 @@ export class PlanExecutor {
}
} else {
// No step executor configured - fail fast
errors.push("No step executor configured");
errors.push('No step executor configured');
break;
}
}
@@ -275,10 +256,7 @@ export class PlanExecutor {
const result: PlanTaskResult = {
success: errors.length === 0,
output:
errors.length === 0
? `Task ${task.id} completed successfully`
: `Task ${task.id} failed`,
output: errors.length === 0 ? `Task ${task.id} completed successfully` : `Task ${task.id} failed`,
filesCreated: filesCreated.length > 0 ? filesCreated : undefined,
filesModified: filesModified.length > 0 ? filesModified : undefined,
errors: errors.length > 0 ? errors : undefined,
@@ -295,15 +273,10 @@ export class PlanExecutor {
/**
* Execute with timeout
*/
private async executeWithTimeout<T>(
promise: Promise<T>,
timeoutMs: number,
): Promise<T> {
private async executeWithTimeout<T>(promise: Promise<T>, timeoutMs: number): Promise<T> {
return Promise.race([
promise,
new Promise<T>((_, reject) =>
setTimeout(() => reject(new Error("Timeout")), timeoutMs),
),
new Promise<T>((_, reject) => setTimeout(() => reject(new Error('Timeout')), timeoutMs)),
]);
}
@@ -323,10 +296,7 @@ export class PlanExecutor {
/**
* Get execution order using topological sort
*/
private getExecutionOrder(
plan: StructuredPlan,
graph: Map<number, number[]>,
): number[] {
private getExecutionOrder(plan: StructuredPlan, graph: Map<number, number[]>): number[] {
const order: number[] = [];
const visited = new Set<number>();
const temp = new Set<number>();
@@ -361,17 +331,12 @@ export class PlanExecutor {
/**
* Check if dependencies are completed
*/
private checkDependencies(
task: PlanTask,
result: PlanExecutionResult,
): boolean {
private checkDependencies(task: PlanTask, result: PlanExecutionResult): boolean {
if (!task.dependencies || task.dependencies.length === 0) {
return true;
}
return task.dependencies.every((depId) =>
result.completedTasks.includes(depId),
);
return task.dependencies.every((depId) => result.completedTasks.includes(depId));
}
/**
@@ -383,7 +348,7 @@ export class PlanExecutor {
this.resumePromise = new Promise((resolve) => {
this.resumeResolve = resolve;
});
this.emit("plan:paused", {} as StructuredPlan);
this.emit('plan:paused', {} as StructuredPlan);
}
}
@@ -396,7 +361,7 @@ export class PlanExecutor {
this.resumeResolve();
this.resumeResolve = undefined;
this.resumePromise = undefined;
this.emit("plan:resumed", {} as StructuredPlan);
this.emit('plan:resumed', {} as StructuredPlan);
}
}
@@ -441,12 +406,7 @@ export class PlanExecutor {
/**
* Emit event
*/
private emit(
event: PlanEvent,
plan: StructuredPlan,
task?: PlanTask,
result?: PlanTaskResult,
): void {
private emit(event: PlanEvent, plan: StructuredPlan, task?: PlanTask, result?: PlanTaskResult): void {
for (const listener of this.listeners) {
try {
listener(event, plan, task, result);
@@ -460,9 +420,7 @@ export class PlanExecutor {
* Check if currently executing
*/
isExecuting(): boolean {
return (
this.abortController !== undefined && !this.abortController.signal.aborted
);
return this.abortController !== undefined && !this.abortController.signal.aborted;
}
/**
@@ -476,9 +434,7 @@ export class PlanExecutor {
/**
* Create a PlanExecutor instance
*/
export function createPlanExecutor(options?: {
stepExecutor?: StepExecutor;
}): PlanExecutor {
export function createPlanExecutor(options?: { stepExecutor?: StepExecutor }): PlanExecutor {
return new PlanExecutor(options);
}
@@ -486,46 +442,23 @@ export function createPlanExecutor(options?: {
* Default step executor (dry run)
*/
export const dryRunExecutor: StepExecutor = async (step, task, _plan) => {
console.log(
`[DRY RUN] Task ${task.id}, Step ${step.number}: ${step.description}`,
);
return { success: true, output: "Dry run completed" };
console.log(`[DRY RUN] Task ${task.id}, Step ${step.number}: ${step.description}`);
return { success: true, output: 'Dry run completed' };
};
/**
* Shell step executor (runs commands)
*
* Uses execFileSync for simple commands (no shell metacharacters) to prevent
* injection. Falls back to sh -c for commands that require shell features
* like pipes, redirects, or subshells — these come from plan configs,
* not user input.
*/
export const shellExecutor: StepExecutor = async (step, _task, _plan) => {
if (!step.command) {
return { success: true, output: "No command to execute" };
return { success: true, output: 'No command to execute' };
}
try {
const needsShell = /[|><;`$(){}]/.test(step.command);
let output: string;
if (needsShell) {
output = execFileSync("sh", ["-c", step.command], {
encoding: "utf-8",
timeout: 60000,
});
} else {
const parts = splitCommand(step.command);
if (parts.length === 0) {
return { success: false, output: "", error: "Empty command" };
}
const [cmd, ...args] = parts;
output = execFileSync(cmd, args, {
encoding: "utf-8",
timeout: 60000,
});
}
const { execSync } = await import('node:child_process');
const output = execSync(step.command, { encoding: 'utf-8', timeout: 60000 });
// Check expected output if provided
if (step.expectedOutput && !output.includes(step.expectedOutput)) {
return {
success: false,
@@ -538,7 +471,7 @@ export const shellExecutor: StepExecutor = async (step, _task, _plan) => {
} catch (error) {
return {
success: false,
output: "",
output: '',
error: (error as Error).message,
};
}
+35 -47
View File
@@ -1,41 +1,35 @@
import { execFileSync } from "node:child_process";
import { existsSync, rmSync } from "node:fs";
import { join, basename } from "node:path";
import { tmpdir } from "node:os";
import { randomUUID } from "node:crypto";
import type { GitProviderAdapter, CloneOptions } from "./base.js";
import { parseShorthand } from "./base.js";
import type { GitProvider, CloneResult } from "../types.js";
import { discoverSkills } from "../skills.js";
import { execSync } from 'node:child_process';
import { existsSync, rmSync } from 'node:fs';
import { join, basename } from 'node:path';
import { tmpdir } from 'node:os';
import { randomUUID } from 'node:crypto';
import type { GitProviderAdapter, CloneOptions } from './base.js';
import { parseShorthand } from './base.js';
import type { GitProvider, CloneResult } from '../types.js';
import { discoverSkills } from '../skills.js';
export class BitbucketProvider implements GitProviderAdapter {
readonly type: GitProvider = "bitbucket";
readonly name = "Bitbucket";
readonly baseUrl = "https://bitbucket.org";
readonly type: GitProvider = 'bitbucket';
readonly name = 'Bitbucket';
readonly baseUrl = 'https://bitbucket.org';
parseSource(
source: string,
): { owner: string; repo: string; subpath?: string } | null {
if (source.startsWith("https://bitbucket.org/")) {
const path = source
.replace("https://bitbucket.org/", "")
.replace(/\.git$/, "");
parseSource(source: string): { owner: string; repo: string; subpath?: string } | null {
if (source.startsWith('https://bitbucket.org/')) {
const path = source.replace('https://bitbucket.org/', '').replace(/\.git$/, '');
return parseShorthand(path);
}
if (source.startsWith("git@bitbucket.org:")) {
const path = source
.replace("git@bitbucket.org:", "")
.replace(/\.git$/, "");
if (source.startsWith('git@bitbucket.org:')) {
const path = source.replace('git@bitbucket.org:', '').replace(/\.git$/, '');
return parseShorthand(path);
}
if (source.startsWith("bitbucket:")) {
return parseShorthand(source.replace("bitbucket:", ""));
if (source.startsWith('bitbucket:')) {
return parseShorthand(source.replace('bitbucket:', ''));
}
if (source.startsWith("bitbucket.org/")) {
return parseShorthand(source.replace("bitbucket.org/", ""));
if (source.startsWith('bitbucket.org/')) {
return parseShorthand(source.replace('bitbucket.org/', ''));
}
return null;
@@ -43,10 +37,10 @@ export class BitbucketProvider implements GitProviderAdapter {
matches(source: string): boolean {
return (
source.startsWith("https://bitbucket.org/") ||
source.startsWith("git@bitbucket.org:") ||
source.startsWith("bitbucket:") ||
source.startsWith("bitbucket.org/")
source.startsWith('https://bitbucket.org/') ||
source.startsWith('git@bitbucket.org:') ||
source.startsWith('bitbucket:') ||
source.startsWith('bitbucket.org/')
);
}
@@ -58,36 +52,30 @@ export class BitbucketProvider implements GitProviderAdapter {
return `git@bitbucket.org:${owner}/${repo}.git`;
}
async clone(
source: string,
_targetDir: string,
options: CloneOptions = {},
): Promise<CloneResult> {
async clone(source: string, _targetDir: string, options: CloneOptions = {}): Promise<CloneResult> {
const parsed = this.parseSource(source);
if (!parsed) {
return { success: false, error: `Invalid Bitbucket source: ${source}` };
}
const { owner, repo, subpath } = parsed;
const cloneUrl = options.ssh
? this.getSshUrl(owner, repo)
: this.getCloneUrl(owner, repo);
const cloneUrl = options.ssh ? this.getSshUrl(owner, repo) : this.getCloneUrl(owner, repo);
const tempDir = join(tmpdir(), `skillkit-${randomUUID()}`);
try {
const args = ["clone"];
const args = ['clone'];
if (options.depth) {
args.push("--depth", String(options.depth));
args.push('--depth', String(options.depth));
}
if (options.branch) {
args.push("--branch", options.branch);
args.push('--branch', options.branch);
}
args.push(cloneUrl, tempDir);
execFileSync("git", args, {
stdio: ["pipe", "pipe", "pipe"],
encoding: "utf-8",
execSync(`git ${args.join(' ')}`, {
stdio: ['pipe', 'pipe', 'pipe'],
encoding: 'utf-8',
});
const searchDir = subpath ? join(tempDir, subpath) : tempDir;
@@ -97,8 +85,8 @@ export class BitbucketProvider implements GitProviderAdapter {
success: true,
path: searchDir,
tempRoot: tempDir,
skills: skills.map((s) => s.name),
discoveredSkills: skills.map((s) => ({
skills: skills.map(s => s.name),
discoveredSkills: skills.map(s => ({
name: s.name,
dirName: basename(s.path),
path: s.path,
+31 -41
View File
@@ -1,34 +1,30 @@
import { execFileSync } from "node:child_process";
import { existsSync, rmSync } from "node:fs";
import { join, basename } from "node:path";
import { tmpdir } from "node:os";
import { randomUUID } from "node:crypto";
import type { GitProviderAdapter, CloneOptions } from "./base.js";
import { parseShorthand, isGitUrl } from "./base.js";
import type { GitProvider, CloneResult } from "../types.js";
import { discoverSkills } from "../skills.js";
import { execSync } from 'node:child_process';
import { existsSync, rmSync } from 'node:fs';
import { join, basename } from 'node:path';
import { tmpdir } from 'node:os';
import { randomUUID } from 'node:crypto';
import type { GitProviderAdapter, CloneOptions } from './base.js';
import { parseShorthand, isGitUrl } from './base.js';
import type { GitProvider, CloneResult } from '../types.js';
import { discoverSkills } from '../skills.js';
export class GitHubProvider implements GitProviderAdapter {
readonly type: GitProvider = "github";
readonly name = "GitHub";
readonly baseUrl = "https://github.com";
readonly type: GitProvider = 'github';
readonly name = 'GitHub';
readonly baseUrl = 'https://github.com';
parseSource(
source: string,
): { owner: string; repo: string; subpath?: string } | null {
if (source.startsWith("https://github.com/")) {
const path = source
.replace("https://github.com/", "")
.replace(/\.git$/, "");
parseSource(source: string): { owner: string; repo: string; subpath?: string } | null {
if (source.startsWith('https://github.com/')) {
const path = source.replace('https://github.com/', '').replace(/\.git$/, '');
return parseShorthand(path);
}
if (source.startsWith("git@github.com:")) {
const path = source.replace("git@github.com:", "").replace(/\.git$/, "");
if (source.startsWith('git@github.com:')) {
const path = source.replace('git@github.com:', '').replace(/\.git$/, '');
return parseShorthand(path);
}
if (!isGitUrl(source) && !source.includes(":")) {
if (!isGitUrl(source) && !source.includes(':')) {
return parseShorthand(source);
}
@@ -37,9 +33,9 @@ export class GitHubProvider implements GitProviderAdapter {
matches(source: string): boolean {
return (
source.startsWith("https://github.com/") ||
source.startsWith("git@github.com:") ||
(!isGitUrl(source) && !source.includes(":") && source.includes("/"))
source.startsWith('https://github.com/') ||
source.startsWith('git@github.com:') ||
(!isGitUrl(source) && !source.includes(':') && source.includes('/'))
);
}
@@ -51,36 +47,30 @@ export class GitHubProvider implements GitProviderAdapter {
return `git@github.com:${owner}/${repo}.git`;
}
async clone(
source: string,
_targetDir: string,
options: CloneOptions = {},
): Promise<CloneResult> {
async clone(source: string, _targetDir: string, options: CloneOptions = {}): Promise<CloneResult> {
const parsed = this.parseSource(source);
if (!parsed) {
return { success: false, error: `Invalid GitHub source: ${source}` };
}
const { owner, repo, subpath } = parsed;
const cloneUrl = options.ssh
? this.getSshUrl(owner, repo)
: this.getCloneUrl(owner, repo);
const cloneUrl = options.ssh ? this.getSshUrl(owner, repo) : this.getCloneUrl(owner, repo);
const tempDir = join(tmpdir(), `skillkit-${randomUUID()}`);
try {
const args = ["clone"];
const args = ['clone'];
if (options.depth) {
args.push("--depth", String(options.depth));
args.push('--depth', String(options.depth));
}
if (options.branch) {
args.push("--branch", options.branch);
args.push('--branch', options.branch);
}
args.push(cloneUrl, tempDir);
execFileSync("git", args, {
stdio: ["pipe", "pipe", "pipe"],
encoding: "utf-8",
execSync(`git ${args.join(' ')}`, {
stdio: ['pipe', 'pipe', 'pipe'],
encoding: 'utf-8',
});
const searchDir = subpath ? join(tempDir, subpath) : tempDir;
@@ -90,8 +80,8 @@ export class GitHubProvider implements GitProviderAdapter {
success: true,
path: searchDir,
tempRoot: tempDir,
skills: skills.map((s) => s.name),
discoveredSkills: skills.map((s) => ({
skills: skills.map(s => s.name),
discoveredSkills: skills.map(s => ({
name: s.name,
dirName: basename(s.path),
path: s.path,
+35 -45
View File
@@ -1,39 +1,35 @@
import { execFileSync } from "node:child_process";
import { existsSync, rmSync } from "node:fs";
import { join, basename } from "node:path";
import { tmpdir } from "node:os";
import { randomUUID } from "node:crypto";
import type { GitProviderAdapter, CloneOptions } from "./base.js";
import { parseShorthand } from "./base.js";
import type { GitProvider, CloneResult } from "../types.js";
import { discoverSkills } from "../skills.js";
import { execSync } from 'node:child_process';
import { existsSync, rmSync } from 'node:fs';
import { join, basename } from 'node:path';
import { tmpdir } from 'node:os';
import { randomUUID } from 'node:crypto';
import type { GitProviderAdapter, CloneOptions } from './base.js';
import { parseShorthand } from './base.js';
import type { GitProvider, CloneResult } from '../types.js';
import { discoverSkills } from '../skills.js';
export class GitLabProvider implements GitProviderAdapter {
readonly type: GitProvider = "gitlab";
readonly name = "GitLab";
readonly baseUrl = "https://gitlab.com";
readonly type: GitProvider = 'gitlab';
readonly name = 'GitLab';
readonly baseUrl = 'https://gitlab.com';
parseSource(
source: string,
): { owner: string; repo: string; subpath?: string } | null {
if (source.startsWith("https://gitlab.com/")) {
const path = source
.replace("https://gitlab.com/", "")
.replace(/\.git$/, "");
parseSource(source: string): { owner: string; repo: string; subpath?: string } | null {
if (source.startsWith('https://gitlab.com/')) {
const path = source.replace('https://gitlab.com/', '').replace(/\.git$/, '');
return parseShorthand(path);
}
if (source.startsWith("git@gitlab.com:")) {
const path = source.replace("git@gitlab.com:", "").replace(/\.git$/, "");
if (source.startsWith('git@gitlab.com:')) {
const path = source.replace('git@gitlab.com:', '').replace(/\.git$/, '');
return parseShorthand(path);
}
if (source.startsWith("gitlab:")) {
return parseShorthand(source.replace("gitlab:", ""));
if (source.startsWith('gitlab:')) {
return parseShorthand(source.replace('gitlab:', ''));
}
if (source.startsWith("gitlab.com/")) {
return parseShorthand(source.replace("gitlab.com/", ""));
if (source.startsWith('gitlab.com/')) {
return parseShorthand(source.replace('gitlab.com/', ''));
}
return null;
@@ -41,10 +37,10 @@ export class GitLabProvider implements GitProviderAdapter {
matches(source: string): boolean {
return (
source.startsWith("https://gitlab.com/") ||
source.startsWith("git@gitlab.com:") ||
source.startsWith("gitlab:") ||
source.startsWith("gitlab.com/")
source.startsWith('https://gitlab.com/') ||
source.startsWith('git@gitlab.com:') ||
source.startsWith('gitlab:') ||
source.startsWith('gitlab.com/')
);
}
@@ -56,36 +52,30 @@ export class GitLabProvider implements GitProviderAdapter {
return `git@gitlab.com:${owner}/${repo}.git`;
}
async clone(
source: string,
_targetDir: string,
options: CloneOptions = {},
): Promise<CloneResult> {
async clone(source: string, _targetDir: string, options: CloneOptions = {}): Promise<CloneResult> {
const parsed = this.parseSource(source);
if (!parsed) {
return { success: false, error: `Invalid GitLab source: ${source}` };
}
const { owner, repo, subpath } = parsed;
const cloneUrl = options.ssh
? this.getSshUrl(owner, repo)
: this.getCloneUrl(owner, repo);
const cloneUrl = options.ssh ? this.getSshUrl(owner, repo) : this.getCloneUrl(owner, repo);
const tempDir = join(tmpdir(), `skillkit-${randomUUID()}`);
try {
const args = ["clone"];
const args = ['clone'];
if (options.depth) {
args.push("--depth", String(options.depth));
args.push('--depth', String(options.depth));
}
if (options.branch) {
args.push("--branch", options.branch);
args.push('--branch', options.branch);
}
args.push(cloneUrl, tempDir);
execFileSync("git", args, {
stdio: ["pipe", "pipe", "pipe"],
encoding: "utf-8",
execSync(`git ${args.join(' ')}`, {
stdio: ['pipe', 'pipe', 'pipe'],
encoding: 'utf-8',
});
const searchDir = subpath ? join(tempDir, subpath) : tempDir;
@@ -95,8 +85,8 @@ export class GitLabProvider implements GitProviderAdapter {
success: true,
path: searchDir,
tempRoot: tempDir,
skills: skills.map((s) => s.name),
discoveredSkills: skills.map((s) => ({
skills: skills.map(s => s.name),
discoveredSkills: skills.map(s => ({
name: s.name,
dirName: basename(s.path),
path: s.path,
+18 -15
View File
@@ -1,20 +1,23 @@
import type { GitProviderAdapter } from './base.js';
import type { GitProvider } from '../types.js';
import { GitHubProvider } from './github.js';
import { GitLabProvider } from './gitlab.js';
import { BitbucketProvider } from './bitbucket.js';
import { LocalProvider } from './local.js';
import { WellKnownProvider } from './wellknown.js';
import type { GitProviderAdapter } from "./base.js";
import type { GitProvider } from "../types.js";
import { GitHubProvider } from "./github.js";
import { GitLabProvider } from "./gitlab.js";
import { BitbucketProvider } from "./bitbucket.js";
import { LocalProvider } from "./local.js";
import { WellKnownProvider } from "./wellknown.js";
import { SkillsShProvider } from "./skills-sh.js";
export * from './base.js';
export * from './github.js';
export * from './gitlab.js';
export * from './bitbucket.js';
export * from './local.js';
export * from './wellknown.js';
export * from "./base.js";
export * from "./github.js";
export * from "./gitlab.js";
export * from "./bitbucket.js";
export * from "./local.js";
export * from "./wellknown.js";
export * from "./skills-sh.js";
const providers: GitProviderAdapter[] = [
new LocalProvider(),
new SkillsShProvider(),
new GitLabProvider(),
new BitbucketProvider(),
new WellKnownProvider(),
@@ -22,7 +25,7 @@ const providers: GitProviderAdapter[] = [
];
export function getProvider(type: GitProvider): GitProviderAdapter | undefined {
return providers.find(p => p.type === type);
return providers.find((p) => p.type === type);
}
export function getAllProviders(): GitProviderAdapter[] {
@@ -30,7 +33,7 @@ export function getAllProviders(): GitProviderAdapter[] {
}
export function detectProvider(source: string): GitProviderAdapter | undefined {
return providers.find(p => p.matches(source));
return providers.find((p) => p.matches(source));
}
export function parseSource(source: string): {
+122
View File
@@ -0,0 +1,122 @@
import { execFileSync } from "node:child_process";
import { existsSync, rmSync } from "node:fs";
import { join, basename, resolve } from "node:path";
import { tmpdir } from "node:os";
import { randomUUID } from "node:crypto";
import type { GitProviderAdapter, CloneOptions } from "./base.js";
import type { GitProvider, CloneResult } from "../types.js";
import { discoverSkills } from "../skills.js";
/**
* Resolves `skills.sh/owner/repo/skill` references to their underlying
* GitHub repos and clones them the same way the GitHubProvider does.
*/
export class SkillsShProvider implements GitProviderAdapter {
readonly type: GitProvider = "skills-sh";
readonly name = "Skills.sh";
readonly baseUrl = "https://skills.sh";
parseSource(
source: string,
): { owner: string; repo: string; subpath?: string } | null {
const cleaned = source
.replace(/^https?:\/\//, "")
.replace(/^skills\.sh\//, "");
if (!this.isSkillsShSource(source)) return null;
const parts = cleaned.split("/").filter(Boolean);
if (parts.length < 2) return null;
return {
owner: parts[0],
repo: parts[1],
subpath: parts.length > 2 ? parts.slice(2).join("/") : undefined,
};
}
matches(source: string): boolean {
return this.isSkillsShSource(source);
}
getCloneUrl(owner: string, repo: string): string {
return `https://github.com/${owner}/${repo}.git`;
}
getSshUrl(owner: string, repo: string): string {
return `git@github.com:${owner}/${repo}.git`;
}
async clone(
source: string,
_targetDir: string,
options: CloneOptions = {},
): Promise<CloneResult> {
const parsed = this.parseSource(source);
if (!parsed) {
return { success: false, error: `Invalid skills.sh source: ${source}` };
}
const { owner, repo, subpath } = parsed;
const cloneUrl = options.ssh
? this.getSshUrl(owner, repo)
: this.getCloneUrl(owner, repo);
const tempDir = join(tmpdir(), `skillkit-skillssh-${randomUUID()}`);
try {
const args = ["clone"];
if (options.depth) {
args.push("--depth", String(options.depth));
}
if (options.branch) {
args.push("--branch", options.branch);
}
args.push(cloneUrl, tempDir);
execFileSync("git", args, {
stdio: ["pipe", "pipe", "pipe"],
encoding: "utf-8",
});
const searchDir = subpath ? join(tempDir, subpath) : tempDir;
if (!resolve(searchDir).startsWith(resolve(tempDir))) {
rmSync(tempDir, { recursive: true, force: true });
return {
success: false,
error: `Invalid subpath in source: ${source}`,
};
}
const skills = discoverSkills(searchDir);
return {
success: true,
path: searchDir,
tempRoot: tempDir,
skills: skills.map((s) => s.name),
discoveredSkills: skills.map((s) => ({
name: s.name,
dirName: basename(s.path),
path: s.path,
})),
};
} catch (error) {
if (existsSync(tempDir)) {
rmSync(tempDir, { recursive: true, force: true });
}
const message = error instanceof Error ? error.message : String(error);
return { success: false, error: `Failed to clone: ${message}` };
}
}
private isSkillsShSource(source: string): boolean {
return (
source.startsWith("skills.sh/") ||
source.startsWith("https://skills.sh/") ||
source.startsWith("http://skills.sh/")
);
}
}
+62 -105
View File
@@ -1,42 +1,24 @@
import { execFileSync } from "node:child_process";
import {
existsSync,
rmSync,
readFileSync,
writeFileSync,
mkdirSync,
} from "node:fs";
import { join, dirname } from "node:path";
import { tmpdir, homedir } from "node:os";
import { randomUUID } from "node:crypto";
import type { SkillIndex, SkillSummary, IndexSource } from "./types.js";
import { discoverSkills, extractFrontmatter } from "../skills.js";
import { execSync } from 'node:child_process';
import { existsSync, rmSync, readFileSync, writeFileSync, mkdirSync } from 'node:fs';
import { join } from 'node:path';
import { tmpdir, homedir } from 'node:os';
import { randomUUID } from 'node:crypto';
import type { SkillIndex, SkillSummary, IndexSource } from './types.js';
import { discoverSkills, extractFrontmatter } from '../skills.js';
/**
* Known skill repositories to index
*/
export const KNOWN_SKILL_REPOS = [
{
owner: "anthropics",
repo: "courses",
description: "Anthropic official courses and skills",
},
{
owner: "vercel-labs",
repo: "ai-sdk-preview-internal-knowledge-base",
description: "Vercel AI SDK skills",
},
{
owner: "composioHQ",
repo: "awesome-claude-skills",
description: "Curated Claude Code skills",
},
{ owner: 'anthropics', repo: 'courses', description: 'Anthropic official courses and skills' },
{ owner: 'vercel-labs', repo: 'ai-sdk-preview-internal-knowledge-base', description: 'Vercel AI SDK skills' },
{ owner: 'composioHQ', repo: 'awesome-claude-skills', description: 'Curated Claude Code skills' },
] as const;
/**
* Index file path
*/
export const INDEX_PATH = join(homedir(), ".skillkit", "index.json");
export const INDEX_PATH = join(homedir(), '.skillkit', 'index.json');
export const INDEX_CACHE_HOURS = 24;
/**
@@ -44,24 +26,17 @@ export const INDEX_CACHE_HOURS = 24;
*/
export async function fetchSkillsFromRepo(
owner: string,
repo: string,
repo: string
): Promise<{ skills: SkillSummary[]; error?: string }> {
if (!/^[\w.-]+$/.test(owner) || !/^[\w.-]+$/.test(repo)) {
return {
skills: [],
error: `Invalid owner or repo name: ${owner}/${repo}`,
};
}
const cloneUrl = `https://github.com/${owner}/${repo}.git`;
const tempDir = join(tmpdir(), `skillkit-fetch-${randomUUID()}`);
try {
// Shallow clone for speed
execFileSync("git", ["clone", "--depth", "1", cloneUrl, tempDir], {
stdio: ["pipe", "pipe", "pipe"],
encoding: "utf-8",
timeout: 60000,
execSync(`git clone --depth 1 ${cloneUrl} ${tempDir}`, {
stdio: ['pipe', 'pipe', 'pipe'],
encoding: 'utf-8',
timeout: 60000, // 60 second timeout
});
// Discover skills in the cloned repo
@@ -69,36 +44,27 @@ export async function fetchSkillsFromRepo(
const skills: SkillSummary[] = [];
for (const skill of discoveredSkills) {
const skillMdPath = join(skill.path, "SKILL.md");
const skillMdPath = join(skill.path, 'SKILL.md');
if (!existsSync(skillMdPath)) continue;
try {
const content = readFileSync(skillMdPath, "utf-8");
const content = readFileSync(skillMdPath, 'utf-8');
const frontmatter = extractFrontmatter(content);
const summary: SkillSummary = {
name: skill.name,
description:
skill.description ||
(frontmatter?.description as string) ||
"No description",
description: skill.description || frontmatter?.description as string || 'No description',
source: `${owner}/${repo}`,
tags: (frontmatter?.tags as string[]) || [],
compatibility: {
frameworks:
((frontmatter?.compatibility as Record<string, unknown>)
?.frameworks as string[]) || [],
languages:
((frontmatter?.compatibility as Record<string, unknown>)
?.languages as string[]) || [],
libraries:
((frontmatter?.compatibility as Record<string, unknown>)
?.libraries as string[]) || [],
frameworks: (frontmatter?.compatibility as Record<string, unknown>)?.frameworks as string[] || [],
languages: (frontmatter?.compatibility as Record<string, unknown>)?.languages as string[] || [],
libraries: (frontmatter?.compatibility as Record<string, unknown>)?.libraries as string[] || [],
},
popularity: 0,
quality: 50,
lastUpdated: new Date().toISOString(),
verified: owner === "anthropics" || owner === "vercel-labs",
verified: owner === 'anthropics' || owner === 'vercel-labs',
};
skills.push(summary);
@@ -110,10 +76,7 @@ export async function fetchSkillsFromRepo(
return { skills };
} catch (error) {
const message = error instanceof Error ? error.message : String(error);
return {
skills: [],
error: `Failed to fetch ${owner}/${repo}: ${message}`,
};
return { skills: [], error: `Failed to fetch ${owner}/${repo}: ${message}` };
} finally {
// Clean up temp directory
if (existsSync(tempDir)) {
@@ -131,7 +94,7 @@ export async function fetchSkillsFromRepo(
*/
export async function buildSkillIndex(
repos: typeof KNOWN_SKILL_REPOS = KNOWN_SKILL_REPOS,
onProgress?: (message: string) => void,
onProgress?: (message: string) => void
): Promise<{ index: SkillIndex; errors: string[] }> {
const allSkills: SkillSummary[] = [];
const sources: IndexSource[] = [];
@@ -162,11 +125,11 @@ export async function buildSkillIndex(
// Add fallback sample skills if no repos could be fetched
if (allSkills.length === 0) {
onProgress?.("No skills fetched, using sample index...");
onProgress?.('No skills fetched, using sample index...');
allSkills.push(...getSampleSkills());
sources.push({
name: "built-in",
url: "https://github.com/rohitg00/skillkit",
name: 'built-in',
url: 'https://github.com/rohitg00/skillkit',
lastFetched: new Date().toISOString(),
skillCount: allSkills.length,
});
@@ -186,7 +149,7 @@ export async function buildSkillIndex(
* Save skill index to cache
*/
export function saveIndex(index: SkillIndex): void {
const indexDir = dirname(INDEX_PATH);
const indexDir = join(homedir(), '.skillkit');
if (!existsSync(indexDir)) {
mkdirSync(indexDir, { recursive: true });
}
@@ -202,7 +165,7 @@ export function loadIndex(): SkillIndex | null {
}
try {
const content = readFileSync(INDEX_PATH, "utf-8");
const content = readFileSync(INDEX_PATH, 'utf-8');
return JSON.parse(content) as SkillIndex;
} catch {
return null;
@@ -214,18 +177,17 @@ export function loadIndex(): SkillIndex | null {
*/
export function isIndexStale(index: SkillIndex): boolean {
const lastUpdated = new Date(index.lastUpdated);
const hoursSinceUpdate =
(Date.now() - lastUpdated.getTime()) / (1000 * 60 * 60);
const hoursSinceUpdate = (Date.now() - lastUpdated.getTime()) / (1000 * 60 * 60);
return hoursSinceUpdate > INDEX_CACHE_HOURS;
}
/**
* Get index status
*/
export function getIndexStatus(): "missing" | "stale" | "fresh" {
export function getIndexStatus(): 'missing' | 'stale' | 'fresh' {
const index = loadIndex();
if (!index) return "missing";
return isIndexStale(index) ? "stale" : "fresh";
if (!index) return 'missing';
return isIndexStale(index) ? 'stale' : 'fresh';
}
/**
@@ -234,14 +196,13 @@ export function getIndexStatus(): "missing" | "stale" | "fresh" {
function getSampleSkills(): SkillSummary[] {
return [
{
name: "react-best-practices",
description:
"Modern React patterns including Server Components, hooks best practices, and performance optimization",
source: "built-in",
tags: ["react", "frontend", "typescript", "nextjs", "performance"],
name: 'react-best-practices',
description: 'Modern React patterns including Server Components, hooks best practices, and performance optimization',
source: 'built-in',
tags: ['react', 'frontend', 'typescript', 'nextjs', 'performance'],
compatibility: {
frameworks: ["react", "nextjs"],
languages: ["typescript", "javascript"],
frameworks: ['react', 'nextjs'],
languages: ['typescript', 'javascript'],
libraries: [],
},
popularity: 1500,
@@ -250,15 +211,14 @@ function getSampleSkills(): SkillSummary[] {
verified: true,
},
{
name: "tailwind-patterns",
description:
"Tailwind CSS utility patterns, responsive design, and component styling best practices",
source: "built-in",
tags: ["tailwind", "css", "styling", "frontend", "responsive"],
name: 'tailwind-patterns',
description: 'Tailwind CSS utility patterns, responsive design, and component styling best practices',
source: 'built-in',
tags: ['tailwind', 'css', 'styling', 'frontend', 'responsive'],
compatibility: {
frameworks: [],
languages: ["typescript", "javascript"],
libraries: ["tailwindcss"],
languages: ['typescript', 'javascript'],
libraries: ['tailwindcss'],
},
popularity: 1200,
quality: 92,
@@ -266,14 +226,13 @@ function getSampleSkills(): SkillSummary[] {
verified: true,
},
{
name: "typescript-strict-patterns",
description:
"TypeScript strict mode patterns, type safety, and advanced type utilities",
source: "built-in",
tags: ["typescript", "types", "safety", "patterns"],
name: 'typescript-strict-patterns',
description: 'TypeScript strict mode patterns, type safety, and advanced type utilities',
source: 'built-in',
tags: ['typescript', 'types', 'safety', 'patterns'],
compatibility: {
frameworks: [],
languages: ["typescript"],
languages: ['typescript'],
libraries: [],
},
popularity: 900,
@@ -282,14 +241,13 @@ function getSampleSkills(): SkillSummary[] {
verified: true,
},
{
name: "security-best-practices",
description:
"Security patterns for web applications including XSS prevention, CSRF, and secure headers",
source: "built-in",
tags: ["security", "xss", "csrf", "headers", "owasp"],
name: 'security-best-practices',
description: 'Security patterns for web applications including XSS prevention, CSRF, and secure headers',
source: 'built-in',
tags: ['security', 'xss', 'csrf', 'headers', 'owasp'],
compatibility: {
frameworks: [],
languages: ["typescript", "javascript", "python"],
languages: ['typescript', 'javascript', 'python'],
libraries: [],
},
popularity: 600,
@@ -298,15 +256,14 @@ function getSampleSkills(): SkillSummary[] {
verified: true,
},
{
name: "testing-patterns",
description:
"Testing patterns with Vitest/Jest including mocking, assertions, and test organization",
source: "built-in",
tags: ["vitest", "jest", "testing", "typescript", "mocking", "tdd"],
name: 'testing-patterns',
description: 'Testing patterns with Vitest/Jest including mocking, assertions, and test organization',
source: 'built-in',
tags: ['vitest', 'jest', 'testing', 'typescript', 'mocking', 'tdd'],
compatibility: {
frameworks: [],
languages: ["typescript", "javascript"],
libraries: ["vitest", "jest"],
languages: ['typescript', 'javascript'],
libraries: ['vitest', 'jest'],
},
popularity: 700,
quality: 86,
+30 -17
View File
@@ -10,7 +10,10 @@ export interface ExternalSkill {
export interface ExternalRegistry {
name: string;
search(query: string, options?: { limit?: number; timeoutMs?: number }): Promise<ExternalSkill[]>;
search(
query: string,
options?: { limit?: number; timeoutMs?: number },
): Promise<ExternalSkill[]>;
}
export interface FederatedResult {
@@ -22,16 +25,21 @@ export interface FederatedResult {
export class RateLimitError extends Error {
constructor(registry: string) {
super(`Rate limited by ${registry} API. Authenticate with a token or wait before retrying.`);
this.name = 'RateLimitError';
super(
`Rate limited by ${registry} API. Authenticate with a token or wait before retrying.`,
);
this.name = "RateLimitError";
}
}
export class GitHubSkillRegistry implements ExternalRegistry {
name = 'github';
private baseUrl = 'https://api.github.com';
name = "github";
private baseUrl = "https://api.github.com";
async search(query: string, options?: { limit?: number; timeoutMs?: number }): Promise<ExternalSkill[]> {
async search(
query: string,
options?: { limit?: number; timeoutMs?: number },
): Promise<ExternalSkill[]> {
const limit = options?.limit ?? 20;
const timeoutMs = options?.timeoutMs ?? 10_000;
const searchQuery = `SKILL.md ${query} in:path,file`;
@@ -41,8 +49,8 @@ export class GitHubSkillRegistry implements ExternalRegistry {
try {
const headers: Record<string, string> = {
Accept: 'application/vnd.github.v3+json',
'User-Agent': 'skillkit-cli',
Accept: "application/vnd.github.v3+json",
"User-Agent": "skillkit-cli",
};
const token = process.env.GITHUB_TOKEN || process.env.GH_TOKEN;
if (token) {
@@ -89,15 +97,15 @@ export class GitHubSkillRegistry implements ExternalRegistry {
if (seen.has(repo)) continue;
seen.add(repo);
const pathParts = item.path.split('/');
const pathParts = item.path.split("/");
const skillName =
pathParts.length > 1
? pathParts[pathParts.length - 2]
: repo.split('/').pop() || repo;
: repo.split("/").pop() || repo;
skills.push({
name: skillName,
description: item.repository.description || '',
description: item.repository.description || "",
source: item.repository.html_url,
registry: this.name,
path: item.path,
@@ -115,7 +123,9 @@ export class GitHubSkillRegistry implements ExternalRegistry {
}
}
export { CommunityRegistry } from './community.js';
export { CommunityRegistry } from "./community.js";
export { SkillsShRegistry, resolveSkillsShUrl } from "./skills-sh.js";
export type { SkillsShStats } from "./skills-sh.js";
export class FederatedSearch {
private registries: ExternalRegistry[] = [];
@@ -124,10 +134,15 @@ export class FederatedSearch {
this.registries.push(registry);
}
async search(query: string, options?: { limit?: number }): Promise<FederatedResult> {
async search(
query: string,
options?: { limit?: number; timeoutMs?: number },
): Promise<FederatedResult> {
const limit = options?.limit ?? 20;
const results = await Promise.allSettled(
this.registries.map((r) => r.search(query, { limit })),
this.registries.map((r) =>
r.search(query, { limit, timeoutMs: options?.timeoutMs }),
),
);
const allSkills: ExternalSkill[] = [];
@@ -135,11 +150,9 @@ export class FederatedSearch {
for (let i = 0; i < results.length; i++) {
const result = results[i];
if (result.status === 'fulfilled' && result.value.length > 0) {
if (result.status === "fulfilled" && result.value.length > 0) {
allSkills.push(...result.value);
activeRegistries.push(this.registries[i].name);
} else if (result.status === 'rejected' && result.reason instanceof RateLimitError) {
throw result.reason;
}
}
+190
View File
@@ -0,0 +1,190 @@
import type { ExternalRegistry, ExternalSkill } from "./index.js";
const SKILLS_SH_BASE = "https://skills.sh";
const SKILLS_SH_CACHE_TTL = 10 * 60 * 1000; // 10 minutes
export interface SkillsShStats {
rank: number;
installs: number;
name: string;
source: string;
skillName: string;
}
interface CachedLeaderboard {
skills: ExternalSkill[];
fetchedAt: number;
}
export class SkillsShRegistry implements ExternalRegistry {
name = "skills.sh";
private cache: CachedLeaderboard | null = null;
async search(
query: string,
options?: { limit?: number; timeoutMs?: number },
): Promise<ExternalSkill[]> {
const limit = options?.limit ?? 20;
const skills = await this.fetchLeaderboard(options?.timeoutMs);
const q = query.toLowerCase();
return skills
.filter(
(s) =>
s.name.toLowerCase().includes(q) ||
s.description.toLowerCase().includes(q) ||
s.source.toLowerCase().includes(q),
)
.slice(0, limit);
}
async getLeaderboard(
limit = 50,
timeoutMs?: number,
): Promise<ExternalSkill[]> {
const skills = await this.fetchLeaderboard(timeoutMs);
return skills.slice(0, limit);
}
async getSkillStats(
owner: string,
repo: string,
skillName: string,
): Promise<SkillsShStats | null> {
const skills = await this.fetchLeaderboard();
const source = `${owner}/${repo}`;
for (let i = 0; i < skills.length; i++) {
const skill = skills[i];
if (skill.name === skillName && skill.source.endsWith(`/${source}`)) {
return {
rank: i + 1,
installs: skill.stars ?? 0,
name: skill.name,
source: skill.source,
skillName,
};
}
}
return null;
}
private async fetchLeaderboard(timeoutMs = 15_000): Promise<ExternalSkill[]> {
if (this.cache && Date.now() - this.cache.fetchedAt < SKILLS_SH_CACHE_TTL) {
return this.cache.skills;
}
const controller = new AbortController();
const timer = setTimeout(() => controller.abort(), timeoutMs);
try {
const response = await fetch(SKILLS_SH_BASE, {
headers: {
Accept: "text/html",
"User-Agent": "skillkit-cli",
},
signal: controller.signal,
});
if (!response.ok) return this.cache?.skills ?? [];
const html = await response.text();
const skills = this.parseLeaderboard(html);
this.cache = { skills, fetchedAt: Date.now() };
return skills;
} catch {
return this.cache?.skills ?? [];
} finally {
clearTimeout(timer);
}
}
private parseLeaderboard(html: string): ExternalSkill[] {
const skills: ExternalSkill[] = [];
const lines = html.split("\n");
for (const line of lines) {
// Match patterns like: [1vercel-labs/skills290.0K] from the page links
const hrefMatch = line.match(
/href="\/([^/]+)\/([^/]+)\/([^"]+)".*?(\d[\d,.]*[KMB]?)\s*<\/a>/,
);
if (hrefMatch) {
const [, owner, repo, skillName, installStr] = hrefMatch;
const installs = this.parseInstallCount(installStr);
skills.push({
name: skillName,
description: `${owner}/${repo}`,
source: `https://github.com/${owner}/${repo}`,
registry: this.name,
path: skillName,
stars: installs,
});
}
}
// Fallback: try simpler pattern matching if structured parsing found nothing
if (skills.length === 0) {
const simplePattern = /skills\.sh\/([^/]+)\/([^/]+)\/([^/"]+)/g;
let match;
while ((match = simplePattern.exec(html)) !== null) {
const [, owner, repo, skillName] = match;
skills.push({
name: skillName,
description: `${owner}/${repo}`,
source: `https://github.com/${owner}/${repo}`,
registry: this.name,
path: skillName,
});
}
}
return skills;
}
private parseInstallCount(str: string): number {
if (!str) return 0;
const cleaned = str.replace(/,/g, "");
const multiplier = cleaned.endsWith("K")
? 1_000
: cleaned.endsWith("M")
? 1_000_000
: cleaned.endsWith("B")
? 1_000_000_000
: 1;
const num = parseFloat(cleaned.replace(/[KMB]$/, ""));
return Math.round(num * multiplier);
}
}
function parseSkillsShParts(
source: string,
): { owner: string; repo: string; rest?: string } | null {
const cleaned = source
.replace(/^https?:\/\//, "")
.replace(/^skills\.sh\//, "");
const parts = cleaned.split("/").filter(Boolean);
if (parts.length < 2) return null;
return {
owner: parts[0],
repo: parts[1],
rest: parts.length > 2 ? parts.slice(2).join("/") : undefined,
};
}
export function resolveSkillsShUrl(
source: string,
): { owner: string; repo: string; skillName?: string } | null {
const parsed = parseSkillsShParts(source);
if (!parsed) return null;
return {
owner: parsed.owner,
repo: parsed.repo,
skillName: parsed.rest,
};
}
+62 -51
View File
@@ -1,66 +1,77 @@
import { z } from 'zod';
import { z } from "zod";
export const AgentType = z.enum([
'claude-code',
'codex',
'cursor',
'antigravity',
'opencode',
'gemini-cli',
'amp',
'clawdbot',
'droid',
'github-copilot',
'goose',
'kilo',
'kiro-cli',
'roo',
'trae',
'windsurf',
'universal',
'cline',
'codebuddy',
'commandcode',
'continue',
'crush',
'factory',
'mcpjam',
'mux',
'neovate',
'openhands',
'pi',
'qoder',
'qwen',
'vercel',
'zencoder',
'devin',
'aider',
'sourcegraph-cody',
'amazon-q',
'augment-code',
'replit-agent',
'bolt',
'lovable',
'tabby',
'tabnine',
'codegpt',
'playcode-agent',
"claude-code",
"codex",
"cursor",
"antigravity",
"opencode",
"gemini-cli",
"amp",
"clawdbot",
"droid",
"github-copilot",
"goose",
"kilo",
"kiro-cli",
"roo",
"trae",
"windsurf",
"universal",
"cline",
"codebuddy",
"commandcode",
"continue",
"crush",
"factory",
"mcpjam",
"mux",
"neovate",
"openhands",
"pi",
"qoder",
"qwen",
"vercel",
"zencoder",
"devin",
"aider",
"sourcegraph-cody",
"amazon-q",
"augment-code",
"replit-agent",
"bolt",
"lovable",
"tabby",
"tabnine",
"codegpt",
"playcode-agent",
]);
export type AgentType = z.infer<typeof AgentType>;
export const GitProvider = z.enum(['github', 'gitlab', 'bitbucket', 'local', 'wellknown']);
export const GitProvider = z.enum([
"github",
"gitlab",
"bitbucket",
"local",
"wellknown",
"skills-sh",
]);
export type GitProvider = z.infer<typeof GitProvider>;
export const SkillFrontmatter = z.object({
name: z.string()
name: z
.string()
.min(1)
.max(64)
.regex(/^[a-z0-9]+(-[a-z0-9]+)*$/, 'Skill name must be lowercase alphanumeric with hyphens, no leading/trailing/consecutive hyphens'),
.regex(
/^[a-z0-9]+(-[a-z0-9]+)*$/,
"Skill name must be lowercase alphanumeric with hyphens, no leading/trailing/consecutive hyphens",
),
description: z.string().min(1).max(1024),
license: z.string().optional(),
compatibility: z.string().max(500).optional(),
metadata: z.record(z.string()).optional(),
'allowed-tools': z.string().optional(),
"allowed-tools": z.string().optional(),
version: z.string().optional(),
author: z.string().optional(),
tags: z.array(z.string()).optional(),
@@ -82,7 +93,7 @@ export const SkillMetadata = z.object({
});
export type SkillMetadata = z.infer<typeof SkillMetadata>;
export const SkillLocation = z.enum(['project', 'global']);
export const SkillLocation = z.enum(["project", "global"]);
export type SkillLocation = z.infer<typeof SkillLocation>;
export const Skill = z.object({
@@ -97,7 +108,7 @@ export type Skill = z.infer<typeof Skill>;
export const SkillkitConfig = z.object({
version: z.literal(1),
agent: AgentType.default('universal'),
agent: AgentType.default("universal"),
skillsDir: z.string().optional(),
enabledSkills: z.array(z.string()).optional(),
disabledSkills: z.array(z.string()).optional(),
-59
View File
@@ -1,59 +0,0 @@
/**
* POSIX-like shell word splitting that respects quoted substrings.
* Handles: simple words, "double quoted", 'single quoted', and
* --flag="value with spaces" correctly.
*/
export function splitCommand(command: string): string[] {
const tokens: string[] = [];
let current = "";
let inSingleQuote = false;
let inDoubleQuote = false;
for (let i = 0; i < command.length; i++) {
const ch = command[i];
if (inSingleQuote) {
if (ch === "'") {
inSingleQuote = false;
} else {
current += ch;
}
continue;
}
if (inDoubleQuote) {
if (ch === '"') {
inDoubleQuote = false;
} else {
current += ch;
}
continue;
}
if (ch === "'") {
inSingleQuote = true;
continue;
}
if (ch === '"') {
inDoubleQuote = true;
continue;
}
if (ch === " " || ch === "\t") {
if (current.length > 0) {
tokens.push(current);
current = "";
}
continue;
}
current += ch;
}
if (current.length > 0) {
tokens.push(current);
}
return tokens;
}
+22 -40
View File
@@ -1,7 +1,7 @@
import got from "got";
import type { Host, HealthCheckResult, HostStatus } from "../types.js";
import { HEALTH_CHECK_TIMEOUT } from "../types.js";
import { getKnownHosts, updateKnownHost } from "../config/hosts-config.js";
import got from 'got';
import type { Host, HealthCheckResult, HostStatus } from '../types.js';
import { HEALTH_CHECK_TIMEOUT } from '../types.js';
import { getKnownHosts, updateKnownHost } from '../config/hosts-config.js';
export interface HealthCheckOptions {
timeout?: number;
@@ -10,7 +10,7 @@ export interface HealthCheckOptions {
export async function checkHostHealth(
host: Host,
options: HealthCheckOptions = {},
options: HealthCheckOptions = {}
): Promise<HealthCheckResult> {
const timeout = options.timeout ?? HEALTH_CHECK_TIMEOUT;
const startTime = Date.now();
@@ -19,42 +19,38 @@ export async function checkHostHealth(
hostId: host.id,
address: host.address,
port: host.port,
status: "unknown",
status: 'unknown',
latencyMs: 0,
checkedAt: new Date().toISOString(),
};
try {
const protocol = host.tls ? "https" : "http";
const url = `${protocol}://${host.address}:${host.port}/health`;
const url = `http://${host.address}:${host.port}/health`;
const response = await got.get(url, {
timeout: { request: timeout },
retry: { limit: 0 },
throwHttpErrors: false,
...(host.tls && host.tlsAllowSelfSigned
? { https: { rejectUnauthorized: false } }
: {}),
});
result.latencyMs = Date.now() - startTime;
if (response.statusCode === 200) {
result.status = "online";
result.status = 'online';
} else {
result.status = "offline";
result.status = 'offline';
result.error = `HTTP ${response.statusCode}`;
}
} catch (err: any) {
result.latencyMs = Date.now() - startTime;
result.status = "offline";
result.error = err.code || err.message || "Connection failed";
result.status = 'offline';
result.error = err.code || err.message || 'Connection failed';
}
if (options.updateStatus !== false) {
await updateKnownHost(host.id, {
status: result.status,
lastSeen: result.status === "online" ? result.checkedAt : host.lastSeen,
lastSeen: result.status === 'online' ? result.checkedAt : host.lastSeen,
});
}
@@ -62,46 +58,44 @@ export async function checkHostHealth(
}
export async function checkAllHostsHealth(
options: HealthCheckOptions = {},
options: HealthCheckOptions = {}
): Promise<HealthCheckResult[]> {
const hosts = await getKnownHosts();
const results = await Promise.all(
hosts.map((host) => checkHostHealth(host, options)),
);
const results = await Promise.all(hosts.map(host => checkHostHealth(host, options)));
return results;
}
export async function getOnlineHosts(): Promise<Host[]> {
const hosts = await getKnownHosts();
return hosts.filter((h) => h.status === "online");
return hosts.filter(h => h.status === 'online');
}
export async function getOfflineHosts(): Promise<Host[]> {
const hosts = await getKnownHosts();
return hosts.filter((h) => h.status === "offline");
return hosts.filter(h => h.status === 'offline');
}
export async function waitForHost(
host: Host,
maxWaitMs = 30000,
intervalMs = 1000,
intervalMs = 1000
): Promise<boolean> {
const deadline = Date.now() + maxWaitMs;
while (Date.now() < deadline) {
const result = await checkHostHealth(host, { updateStatus: false });
if (result.status === "online") {
if (result.status === 'online') {
await updateKnownHost(host.id, {
status: "online",
status: 'online',
lastSeen: new Date().toISOString(),
});
return true;
}
await new Promise((resolve) => setTimeout(resolve, intervalMs));
await new Promise(resolve => setTimeout(resolve, intervalMs));
}
return false;
@@ -111,21 +105,9 @@ export class HealthMonitor {
private interval: NodeJS.Timeout | null = null;
private running = false;
private checking = false;
private onStatusChange?: (
host: Host,
oldStatus: HostStatus,
newStatus: HostStatus,
) => void;
private onStatusChange?: (host: Host, oldStatus: HostStatus, newStatus: HostStatus) => void;
constructor(
options: {
onStatusChange?: (
host: Host,
oldStatus: HostStatus,
newStatus: HostStatus,
) => void;
} = {},
) {
constructor(options: { onStatusChange?: (host: Host, oldStatus: HostStatus, newStatus: HostStatus) => void } = {}) {
this.onStatusChange = options.onStatusChange;
}
+39 -52
View File
@@ -1,8 +1,11 @@
import { generateKeyPairSync, createHash } from "node:crypto";
import { readFile, writeFile, mkdir } from "node:fs/promises";
import { existsSync } from "node:fs";
import { join } from "node:path";
import { homedir } from "node:os";
import {
generateKeyPairSync,
createHash,
} from 'node:crypto';
import { readFile, writeFile, mkdir } from 'node:fs/promises';
import { existsSync } from 'node:fs';
import { join } from 'node:path';
import { homedir } from 'node:os';
export interface TLSContextOptions {
cert?: string;
@@ -28,26 +31,26 @@ export interface TLSConfig {
rejectUnauthorized?: boolean;
}
const DEFAULT_CERT_PATH = join(homedir(), ".skillkit", "mesh", "certs");
const DEFAULT_CERT_PATH = join(homedir(), '.skillkit', 'mesh', 'certs');
function generateSelfSignedCertificate(
hostId: string,
hostName: string,
validDays: number = 365,
validDays: number = 365
): { cert: string; key: string } {
const { publicKey, privateKey } = generateKeyPairSync("rsa", {
const { publicKey, privateKey } = generateKeyPairSync('rsa', {
modulusLength: 2048,
publicKeyEncoding: { type: "spki", format: "pem" },
privateKeyEncoding: { type: "pkcs8", format: "pem" },
publicKeyEncoding: { type: 'spki', format: 'pem' },
privateKeyEncoding: { type: 'pkcs8', format: 'pem' },
});
const notBefore = new Date();
const notAfter = new Date();
notAfter.setDate(notAfter.getDate() + validDays);
const serialNumber = createHash("sha256")
const serialNumber = createHash('sha256')
.update(hostId + Date.now().toString())
.digest("hex")
.digest('hex')
.slice(0, 16);
const certPem = createSimpleCert({
@@ -58,7 +61,7 @@ function generateSelfSignedCertificate(
serialNumber,
notBefore,
notAfter,
altNames: ["localhost", "127.0.0.1", hostName],
altNames: ['localhost', '127.0.0.1', hostName],
});
return {
@@ -80,15 +83,15 @@ interface CertParams {
function createSimpleCert(params: CertParams): string {
const base64Encode = (str: string): string =>
Buffer.from(str).toString("base64");
Buffer.from(str).toString('base64');
const formatDate = (date: Date): string => {
const y = date.getUTCFullYear().toString().slice(-2);
const m = (date.getUTCMonth() + 1).toString().padStart(2, "0");
const d = date.getUTCDate().toString().padStart(2, "0");
const h = date.getUTCHours().toString().padStart(2, "0");
const min = date.getUTCMinutes().toString().padStart(2, "0");
const s = date.getUTCSeconds().toString().padStart(2, "0");
const m = (date.getUTCMonth() + 1).toString().padStart(2, '0');
const d = date.getUTCDate().toString().padStart(2, '0');
const h = date.getUTCHours().toString().padStart(2, '0');
const min = date.getUTCMinutes().toString().padStart(2, '0');
const s = date.getUTCSeconds().toString().padStart(2, '0');
return `${y}${m}${d}${h}${min}${s}Z`;
};
@@ -106,13 +109,13 @@ function createSimpleCert(params: CertParams): string {
const certData = JSON.stringify(certInfo);
const certBase64 = base64Encode(certData);
const lines: string[] = ["-----BEGIN CERTIFICATE-----"];
const lines: string[] = ['-----BEGIN CERTIFICATE-----'];
for (let i = 0; i < certBase64.length; i += 64) {
lines.push(certBase64.slice(i, i + 64));
}
lines.push("-----END CERTIFICATE-----");
lines.push('-----END CERTIFICATE-----');
return lines.join("\n");
return lines.join('\n');
}
export class TLSManager {
@@ -130,15 +133,15 @@ export class TLSManager {
async generateCertificate(
hostId: string,
hostName: string = "localhost",
validDays: number = 365,
hostName: string = 'localhost',
validDays: number = 365
): Promise<CertificateInfo> {
await this.ensureDirectory();
const { cert, key } = generateSelfSignedCertificate(
hostId,
hostName,
validDays,
validDays
);
const certFile = join(this.certPath, `${hostId}.crt`);
@@ -147,7 +150,7 @@ export class TLSManager {
await writeFile(certFile, cert, { mode: 0o644 });
await writeFile(keyFile, key, { mode: 0o600 });
const fingerprint = createHash("sha256").update(cert).digest("hex");
const fingerprint = createHash('sha256').update(cert).digest('hex');
const notBefore = new Date();
const notAfter = new Date();
notAfter.setDate(notAfter.getDate() + validDays);
@@ -170,9 +173,9 @@ export class TLSManager {
return null;
}
const cert = await readFile(certFile, "utf-8");
const key = await readFile(keyFile, "utf-8");
const fingerprint = createHash("sha256").update(cert).digest("hex");
const cert = await readFile(certFile, 'utf-8');
const key = await readFile(keyFile, 'utf-8');
const fingerprint = createHash('sha256').update(cert).digest('hex');
return {
cert,
@@ -186,7 +189,7 @@ export class TLSManager {
async loadOrCreateCertificate(
hostId: string,
hostName: string = "localhost",
hostName: string = 'localhost'
): Promise<CertificateInfo> {
const existing = await this.loadCertificate(hostId);
if (existing) {
@@ -207,25 +210,15 @@ export class TLSManager {
};
}
/**
* @param options.allowSelfSigned - WARNING: disables certificate validation
* (rejectUnauthorized=false). Only safe for local development/testing.
* Defaults to true since the mesh system generates self-signed certs.
*/
createServerContext(
certInfo: CertificateInfo,
options?: {
requestClientCert?: boolean;
trustedCAs?: string[];
allowSelfSigned?: boolean;
},
options?: { requestClientCert?: boolean; trustedCAs?: string[] }
): TLSContextOptions {
const allowSelfSigned = options?.allowSelfSigned ?? true;
const context: TLSContextOptions = {
cert: certInfo.cert,
key: certInfo.key,
requestCert: options?.requestClientCert ?? false,
rejectUnauthorized: !allowSelfSigned,
rejectUnauthorized: false,
};
if (options?.trustedCAs?.length) {
@@ -238,15 +231,10 @@ export class TLSManager {
createClientContext(
certInfo?: CertificateInfo,
options?: {
serverFingerprint?: string;
trustedCAs?: string[];
allowSelfSigned?: boolean;
},
options?: { serverFingerprint?: string; trustedCAs?: string[] }
): TLSContextOptions {
const allowSelfSigned = options?.allowSelfSigned ?? true;
const context: TLSContextOptions = {
rejectUnauthorized: !allowSelfSigned,
rejectUnauthorized: false,
};
if (certInfo) {
@@ -256,19 +244,18 @@ export class TLSManager {
if (options?.trustedCAs?.length) {
context.ca = options.trustedCAs;
context.rejectUnauthorized = true;
}
return context;
}
static computeCertFingerprint(cert: string): string {
return createHash("sha256").update(cert).digest("hex");
return createHash('sha256').update(cert).digest('hex');
}
static verifyCertFingerprint(
cert: string,
expectedFingerprint: string,
expectedFingerprint: string
): boolean {
const actual = TLSManager.computeCertFingerprint(cert);
return actual.toLowerCase() === expectedFingerprint.toLowerCase();
+34 -59
View File
@@ -1,18 +1,18 @@
import got, { type Got } from "got";
import { randomUUID } from "node:crypto";
import got, { type Got } from 'got';
import { randomUUID } from 'node:crypto';
import type {
TransportMessage,
SecureTransportMessage,
Host,
} from "../types.js";
import { HEALTH_CHECK_TIMEOUT } from "../types.js";
import { PeerIdentity } from "../crypto/identity.js";
import { AuthManager, createBearerHeader } from "../security/auth.js";
} from '../types.js';
import { HEALTH_CHECK_TIMEOUT } from '../types.js';
import { PeerIdentity } from '../crypto/identity.js';
import {
type MeshSecurityConfig,
DEFAULT_SECURITY_CONFIG,
} from "../security/config.js";
import { SecureKeystore } from "../crypto/keystore.js";
AuthManager,
createBearerHeader,
} from '../security/auth.js';
import { type MeshSecurityConfig, DEFAULT_SECURITY_CONFIG } from '../security/config.js';
import { SecureKeystore } from '../crypto/keystore.js';
export interface SecureHttpTransportOptions {
timeout?: number;
@@ -48,7 +48,8 @@ export class SecureHttpTransport {
this.authToken = options.authToken ?? null;
this.security = options.security ?? DEFAULT_SECURITY_CONFIG;
const protocol = this.security.transport.tls !== "none" ? "https" : "http";
const protocol =
this.security.transport.tls !== 'none' ? 'https' : 'http';
const baseUrl = `${protocol}://${host.address}:${host.port}`;
this.client = got.extend({
@@ -59,13 +60,11 @@ export class SecureHttpTransport {
calculateDelay: () => this.options.retryDelay!,
},
https: {
// MITM risk: disabling verification for self-signed mode.
// Ideally supply the CA cert via the `ca` option instead.
rejectUnauthorized: this.security.transport.tls !== "self-signed",
rejectUnauthorized: false,
},
headers: {
"Content-Type": "application/json",
"X-SkillKit-Transport": "secure-http",
'Content-Type': 'application/json',
'X-SkillKit-Transport': 'secure-http',
...this.options.headers,
},
});
@@ -89,11 +88,11 @@ export class SecureHttpTransport {
const headers: Record<string, string> = {};
if (this.authToken) {
headers["Authorization"] = createBearerHeader(this.authToken);
headers['Authorization'] = createBearerHeader(this.authToken);
}
if (this.identity) {
headers["X-SkillKit-Fingerprint"] = this.identity.fingerprint;
headers['X-SkillKit-Fingerprint'] = this.identity.fingerprint;
}
return headers;
@@ -106,8 +105,8 @@ export class SecureHttpTransport {
const message: TransportMessage = {
id: randomUUID(),
type: "request",
from: this.identity?.fingerprint ?? "local",
type: 'request',
from: this.identity?.fingerprint ?? 'local',
to: path,
payload,
timestamp: new Date().toISOString(),
@@ -139,9 +138,9 @@ export class SecureHttpTransport {
async sendMessage(
to: string,
type: string,
payload: unknown,
payload: unknown
): Promise<TransportMessage> {
return this.send("message", {
return this.send('message', {
to,
type,
payload,
@@ -149,7 +148,7 @@ export class SecureHttpTransport {
}
async registerPeer(registration: unknown): Promise<TransportMessage> {
return this.send("peer/register", registration);
return this.send('peer/register', registration);
}
async getPeers(): Promise<TransportMessage> {
@@ -159,7 +158,7 @@ export class SecureHttpTransport {
const secureHeaders = await this.getSecureHeaders();
const response = await this.client.get("peers", {
const response = await this.client.get('peers', {
headers: secureHeaders,
});
@@ -168,7 +167,7 @@ export class SecureHttpTransport {
async healthCheck(): Promise<boolean> {
try {
const response = await this.client.get("health", {
const response = await this.client.get('health', {
headers: await this.getSecureHeaders(),
});
return response.statusCode === 200;
@@ -190,7 +189,7 @@ export async function sendToHostSecure(
host: Host,
path: string,
payload: unknown,
options: SecureHttpTransportOptions = {},
options: SecureHttpTransportOptions = {}
): Promise<TransportMessage> {
const transport = new SecureHttpTransport(host, options);
await transport.initialize();
@@ -201,7 +200,7 @@ export async function broadcastToHostsSecure(
hosts: Host[],
path: string,
payload: unknown,
options: SecureHttpTransportOptions = {},
options: SecureHttpTransportOptions = {}
): Promise<Map<string, TransportMessage | Error>> {
const results = new Map<string, TransportMessage | Error>();
@@ -213,49 +212,25 @@ export async function broadcastToHostsSecure(
} catch (err) {
results.set(host.id, err as Error);
}
}),
})
);
return results;
}
export async function verifySecureMessage(
message: SecureTransportMessage,
): Promise<{
valid: boolean;
error?: string;
}> {
if (
!message.signature ||
!message.senderPublicKey ||
!message.senderFingerprint
) {
return { valid: false, error: "Missing signature fields" };
export function verifySecureMessage(
message: SecureTransportMessage
): { valid: boolean; error?: string } {
if (!message.signature || !message.senderPublicKey || !message.senderFingerprint) {
return { valid: false, error: 'Missing signature fields' };
}
const computedFingerprint = PeerIdentity.computeFingerprint(
Buffer.from(message.senderPublicKey, "hex"),
Buffer.from(message.senderPublicKey, 'hex')
);
if (computedFingerprint !== message.senderFingerprint) {
return { valid: false, error: "Fingerprint mismatch" };
}
const {
signature,
senderFingerprint,
senderPublicKey,
nonce,
...baseMessage
} = message;
const messageJson = JSON.stringify(baseMessage);
const isValidSignature = await PeerIdentity.verifyHex(
signature,
Buffer.from(messageJson).toString("hex"),
senderPublicKey,
);
if (!isValidSignature) {
return { valid: false, error: "Invalid signature" };
return { valid: false, error: 'Fingerprint mismatch' };
}
return { valid: true };
+100 -150
View File
@@ -1,29 +1,19 @@
import WebSocket, { WebSocketServer } from "ws";
import {
createServer as createHttpsServer,
type Server as HttpsServer,
} from "node:https";
import { randomUUID } from "node:crypto";
import WebSocket, { WebSocketServer } from 'ws';
import { createServer as createHttpsServer, type Server as HttpsServer } from 'node:https';
import { randomUUID } from 'node:crypto';
import type {
TransportMessage,
SecureTransportMessage,
Host,
} from "../types.js";
import { DEFAULT_PORT } from "../types.js";
import { PeerIdentity } from "../crypto/identity.js";
import { MessageEncryption } from "../crypto/encryption.js";
import {
AuthManager,
type AuthChallengeRequest,
type AuthChallengeResponse,
} from "../security/auth.js";
import { TLSManager, type CertificateInfo } from "../security/tls.js";
import {
type MeshSecurityConfig,
DEFAULT_SECURITY_CONFIG,
} from "../security/config.js";
import { SecureKeystore } from "../crypto/keystore.js";
import { hexToBytes } from "@noble/hashes/utils";
} from '../types.js';
import { DEFAULT_PORT } from '../types.js';
import { PeerIdentity } from '../crypto/identity.js';
import { MessageEncryption } from '../crypto/encryption.js';
import { AuthManager, type AuthChallengeRequest, type AuthChallengeResponse } from '../security/auth.js';
import { TLSManager, type CertificateInfo } from '../security/tls.js';
import { type MeshSecurityConfig, DEFAULT_SECURITY_CONFIG } from '../security/config.js';
import { SecureKeystore } from '../crypto/keystore.js';
import { hexToBytes } from '@noble/hashes/utils';
export interface SecureWebSocketOptions {
timeout?: number;
@@ -38,7 +28,7 @@ export interface SecureWebSocketOptions {
export type SecureMessageHandler = (
message: TransportMessage,
socket: WebSocket,
senderFingerprint?: string,
senderFingerprint?: string
) => void;
interface AuthenticatedClient {
@@ -51,9 +41,7 @@ interface AuthenticatedClient {
export class SecureWebSocketTransport {
private socket: WebSocket | null = null;
private host: Host;
private options: Required<
Omit<SecureWebSocketOptions, "identity" | "keystore">
>;
private options: Required<Omit<SecureWebSocketOptions, 'identity' | 'keystore'>>;
private identity: PeerIdentity | null = null;
private keystore: SecureKeystore | null = null;
private authManager: AuthManager | null = null;
@@ -89,7 +77,7 @@ export class SecureWebSocketTransport {
private getUrl(): string {
const protocol =
this.options.security.transport.tls !== "none" ? "wss" : "ws";
this.options.security.transport.tls !== 'none' ? 'wss' : 'ws';
return `${protocol}://${this.host.address}:${this.host.port}/ws`;
}
@@ -102,18 +90,17 @@ export class SecureWebSocketTransport {
const url = this.getUrl();
const wsOptions: WebSocket.ClientOptions = {
handshakeTimeout: this.options.timeout,
rejectUnauthorized:
this.options.security.transport.tls === "self-signed" ? false : true,
rejectUnauthorized: false,
};
this.socket = new WebSocket(url, wsOptions);
const timeout = setTimeout(() => {
this.socket?.close();
reject(new Error("Connection timeout"));
reject(new Error('Connection timeout'));
}, this.options.timeout);
this.socket.on("open", async () => {
this.socket.on('open', async () => {
clearTimeout(timeout);
this.connected = true;
this.reconnectAttempts = 0;
@@ -134,11 +121,11 @@ export class SecureWebSocketTransport {
resolve();
});
this.socket.on("message", async (data) => {
this.socket.on('message', async (data) => {
try {
const raw = JSON.parse(data.toString());
if (raw.type === "auth:challenge") {
if (raw.type === 'auth:challenge') {
return;
}
@@ -146,12 +133,10 @@ export class SecureWebSocketTransport {
let senderFingerprint: string | undefined;
if (this.encryption && raw.ciphertext) {
const decrypted = this.encryption.decryptToObject<TransportMessage>(
{
nonce: raw.nonce,
ciphertext: raw.ciphertext,
},
);
const decrypted = this.encryption.decryptToObject<TransportMessage>({
nonce: raw.nonce,
ciphertext: raw.ciphertext,
});
message = decrypted;
senderFingerprint = raw.senderFingerprint;
} else if (raw.signature) {
@@ -170,14 +155,13 @@ export class SecureWebSocketTransport {
}
this.messageHandlers.forEach((handler) =>
handler(message, this.socket!, senderFingerprint),
handler(message, this.socket!, senderFingerprint)
);
} catch (err) {
console.error("[SecureWebSocket] client message handler error:", err);
} catch {
}
});
this.socket.on("close", () => {
this.socket.on('close', () => {
this.connected = false;
this.authenticated = false;
if (this.options.reconnect) {
@@ -185,7 +169,7 @@ export class SecureWebSocketTransport {
}
});
this.socket.on("error", (err) => {
this.socket.on('error', (err) => {
clearTimeout(timeout);
if (!this.connected) {
reject(err);
@@ -199,49 +183,43 @@ export class SecureWebSocketTransport {
const handleChallenge = async (data: WebSocket.Data) => {
try {
const msg = JSON.parse(data.toString());
if (msg.type === "auth:challenge") {
if (msg.type === 'auth:challenge') {
const challenge: AuthChallengeRequest = {
challenge: msg.challenge,
timestamp: msg.timestamp,
};
const response =
await this.authManager!.respondToChallenge(challenge);
const response = await this.authManager!.respondToChallenge(challenge);
this.socket!.send(
JSON.stringify({
type: "auth:response",
type: 'auth:response',
...response,
}),
})
);
} else if (msg.type === "auth:success") {
this.socket!.off("message", handleChallenge);
clearTimeout(authTimeout);
} else if (msg.type === 'auth:success') {
this.socket!.off('message', handleChallenge);
if (msg.serverPublicKey) {
const serverPubKey = hexToBytes(msg.serverPublicKey);
const sharedSecret =
this.identity!.deriveSharedSecret(serverPubKey);
const sharedSecret = this.identity!.deriveSharedSecret(serverPubKey);
this.encryption = new MessageEncryption(sharedSecret);
}
resolve();
} else if (msg.type === "auth:failed") {
this.socket!.off("message", handleChallenge);
clearTimeout(authTimeout);
reject(new Error(msg.error || "Authentication failed"));
} else if (msg.type === 'auth:failed') {
this.socket!.off('message', handleChallenge);
reject(new Error(msg.error || 'Authentication failed'));
}
} catch (err) {
this.socket!.off("message", handleChallenge);
clearTimeout(authTimeout);
reject(err);
}
};
this.socket!.on("message", handleChallenge);
this.socket!.on('message', handleChallenge);
const authTimeout = setTimeout(() => {
this.socket!.off("message", handleChallenge);
reject(new Error("Authentication timeout"));
setTimeout(() => {
this.socket!.off('message', handleChallenge);
reject(new Error('Authentication timeout'));
}, this.options.timeout);
});
}
@@ -263,14 +241,14 @@ export class SecureWebSocketTransport {
}
async send(
message: Omit<TransportMessage, "id" | "timestamp">,
message: Omit<TransportMessage, 'id' | 'timestamp'>
): Promise<void> {
if (!this.socket || !this.connected) {
throw new Error("Not connected");
throw new Error('Not connected');
}
if (!this.authenticated) {
throw new Error("Not authenticated");
throw new Error('Not authenticated');
}
const fullMessage: TransportMessage = {
@@ -283,7 +261,7 @@ export class SecureWebSocketTransport {
if (
this.encryption &&
this.options.security.transport.encryption === "required"
this.options.security.transport.encryption === 'required'
) {
const encrypted = this.encryption.encryptObject(fullMessage);
dataToSend = JSON.stringify({
@@ -370,7 +348,7 @@ export class SecureWebSocketServer {
identity?: PeerIdentity;
keystore?: SecureKeystore;
hostId?: string;
} = {},
} = {}
) {
this.port = port;
this.security = options.security ?? DEFAULT_SECURITY_CONFIG;
@@ -388,11 +366,11 @@ export class SecureWebSocketServer {
}
this.authManager = new AuthManager(this.identity);
if (this.security.transport.tls !== "none") {
if (this.security.transport.tls !== 'none') {
this.tlsManager = new TLSManager();
this.certInfo = await this.tlsManager.loadOrCreateCertificate(
this.hostId,
"localhost",
'localhost'
);
}
}
@@ -403,15 +381,7 @@ export class SecureWebSocketServer {
await this.initialize();
return new Promise((resolve, reject) => {
if (this.security.transport.tls !== "none") {
if (!this.certInfo) {
reject(
new Error(
"TLS is configured but certificate is not available; refusing to start in plaintext",
),
);
return;
}
if (this.security.transport.tls !== 'none' && this.certInfo) {
this.httpsServer = createHttpsServer({
cert: this.certInfo.cert,
key: this.certInfo.key,
@@ -419,7 +389,7 @@ export class SecureWebSocketServer {
this.wss = new WebSocketServer({
server: this.httpsServer,
path: "/ws",
path: '/ws',
});
this.httpsServer.listen(this.port, () => {
@@ -427,19 +397,19 @@ export class SecureWebSocketServer {
resolve();
});
this.httpsServer.on("error", reject);
this.httpsServer.on('error', reject);
} else {
this.wss = new WebSocketServer({ port: this.port, path: "/ws" });
this.wss = new WebSocketServer({ port: this.port, path: '/ws' });
this.wss.on("listening", () => {
this.wss.on('listening', () => {
this.running = true;
resolve();
});
this.wss.on("error", reject);
this.wss.on('error', reject);
}
this.wss.on("connection", (socket) => {
this.wss.on('connection', (socket) => {
this.handleConnection(socket);
});
});
@@ -457,16 +427,16 @@ export class SecureWebSocketServer {
} else {
this.clients.set(socket, {
socket,
fingerprint: "anonymous",
publicKey: "",
fingerprint: 'anonymous',
publicKey: '',
});
}
socket.on("message", async (data) => {
socket.on('message', async (data) => {
try {
const raw = JSON.parse(data.toString());
if (raw.type === "auth:response") {
if (raw.type === 'auth:response') {
return;
}
@@ -477,12 +447,10 @@ export class SecureWebSocketServer {
let senderFingerprint: string | undefined = client.fingerprint;
if (client.encryption && raw.ciphertext) {
const decrypted = client.encryption.decryptToObject<TransportMessage>(
{
nonce: raw.nonce,
ciphertext: raw.ciphertext,
},
);
const decrypted = client.encryption.decryptToObject<TransportMessage>({
nonce: raw.nonce,
ciphertext: raw.ciphertext,
});
message = decrypted;
} else if (raw.signature) {
const secure = raw as SecureTransportMessage;
@@ -500,46 +468,41 @@ export class SecureWebSocketServer {
}
this.messageHandlers.forEach((handler) =>
handler(message, socket, senderFingerprint),
handler(message, socket, senderFingerprint)
);
} catch (err) {
console.error("[SecureWebSocket] server message handler error:", err);
} catch {
}
});
socket.on("error", (err) => {
console.error("[SecureWebSocket] socket error:", err);
});
socket.on("close", () => {
socket.on('close', () => {
this.clients.delete(socket);
});
}
private async performServerHandshake(
socket: WebSocket,
socket: WebSocket
): Promise<AuthenticatedClient> {
return new Promise((resolve, reject) => {
const challenge = this.authManager!.createChallenge();
socket.send(
JSON.stringify({
type: "auth:challenge",
type: 'auth:challenge',
...challenge,
}),
})
);
const timeout = setTimeout(() => {
socket.off("message", handleResponse);
reject(new Error("Handshake timeout"));
socket.off('message', handleResponse);
reject(new Error('Handshake timeout'));
}, 10000);
const handleResponse = async (data: WebSocket.Data) => {
try {
const msg = JSON.parse(data.toString());
if (msg.type === "auth:response") {
if (msg.type === 'auth:response') {
clearTimeout(timeout);
socket.off("message", handleResponse);
socket.off('message', handleResponse);
const response: AuthChallengeResponse = {
challenge: msg.challenge,
@@ -555,44 +518,41 @@ export class SecureWebSocketServer {
if (!result.authenticated) {
socket.send(
JSON.stringify({
type: "auth:failed",
type: 'auth:failed',
error: result.error,
}),
})
);
reject(new Error(result.error));
return;
}
if (this.keystore) {
const isRevoked = await this.keystore.isRevoked(
result.fingerprint!,
);
const isRevoked = await this.keystore.isRevoked(result.fingerprint!);
if (isRevoked) {
socket.send(
JSON.stringify({
type: "auth:failed",
error: "Peer is revoked",
}),
type: 'auth:failed',
error: 'Peer is revoked',
})
);
reject(new Error("Peer is revoked"));
reject(new Error('Peer is revoked'));
return;
}
}
let encryption: MessageEncryption | undefined;
if (this.security.transport.encryption === "required") {
if (this.security.transport.encryption === 'required') {
const clientPubKey = hexToBytes(response.publicKey);
const sharedSecret =
this.identity!.deriveSharedSecret(clientPubKey);
const sharedSecret = this.identity!.deriveSharedSecret(clientPubKey);
encryption = new MessageEncryption(sharedSecret);
}
socket.send(
JSON.stringify({
type: "auth:success",
type: 'auth:success',
serverFingerprint: this.identity!.fingerprint,
serverPublicKey: this.identity!.publicKeyHex,
}),
})
);
resolve({
@@ -608,7 +568,7 @@ export class SecureWebSocketServer {
}
};
socket.on("message", handleResponse);
socket.on('message', handleResponse);
});
}
@@ -628,7 +588,7 @@ export class SecureWebSocketServer {
}
async broadcast(
message: Omit<TransportMessage, "id" | "timestamp">,
message: Omit<TransportMessage, 'id' | 'timestamp'>
): Promise<void> {
const fullMessage: TransportMessage = {
...message,
@@ -636,19 +596,6 @@ export class SecureWebSocketServer {
timestamp: new Date().toISOString(),
};
let sharedSignedData: string | null = null;
if (this.identity) {
const signature = await this.identity.signObject(fullMessage);
const secureMessage: SecureTransportMessage = {
...fullMessage,
signature,
senderFingerprint: this.identity.fingerprint,
senderPublicKey: this.identity.publicKeyHex,
nonce: randomUUID(),
};
sharedSignedData = JSON.stringify(secureMessage);
}
for (const [socket, client] of this.clients) {
if (socket.readyState !== WebSocket.OPEN) continue;
@@ -663,22 +610,27 @@ export class SecureWebSocketServer {
ciphertext: encrypted.ciphertext,
timestamp: fullMessage.timestamp,
});
} else if (sharedSignedData) {
dataToSend = sharedSignedData;
} else if (this.identity) {
const signature = await this.identity.signObject(fullMessage);
const secureMessage: SecureTransportMessage = {
...fullMessage,
signature,
senderFingerprint: this.identity.fingerprint,
senderPublicKey: this.identity.publicKeyHex,
nonce: randomUUID(),
};
dataToSend = JSON.stringify(secureMessage);
} else {
dataToSend = JSON.stringify(fullMessage);
}
socket.send(dataToSend, (err) => {
if (err)
console.error("[SecureWebSocketServer] broadcast send error:", err);
});
socket.send(dataToSend);
}
}
async sendTo(
socket: WebSocket,
message: Omit<TransportMessage, "id" | "timestamp">,
message: Omit<TransportMessage, 'id' | 'timestamp'>
): Promise<void> {
if (socket.readyState !== WebSocket.OPEN) return;
@@ -716,9 +668,7 @@ export class SecureWebSocketServer {
dataToSend = JSON.stringify(fullMessage);
}
socket.send(dataToSend, (err) => {
if (err) console.error("[SecureWebSocketServer] sendTo error:", err);
});
socket.send(dataToSend);
}
onMessage(handler: SecureMessageHandler): () => void {
+3 -5
View File
@@ -1,4 +1,4 @@
export type HostStatus = "online" | "offline" | "unknown";
export type HostStatus = 'online' | 'offline' | 'unknown';
export interface Host {
id: string;
@@ -10,8 +10,6 @@ export interface Host {
lastSeen: string;
version?: string;
metadata?: Record<string, unknown>;
tls?: boolean;
tlsAllowSelfSigned?: boolean;
}
export interface Peer {
@@ -48,7 +46,7 @@ export interface HostsFile {
}
export interface DiscoveryMessage {
type: "announce" | "query" | "response";
type: 'announce' | 'query' | 'response';
hostId: string;
hostName: string;
address: string;
@@ -123,4 +121,4 @@ export const DEFAULT_PORT = 9876;
export const DEFAULT_DISCOVERY_PORT = 9877;
export const HEALTH_CHECK_TIMEOUT = 5000;
export const DISCOVERY_INTERVAL = 30000;
export const MESH_VERSION = "1.7.11";
export const MESH_VERSION = '1.7.11';
+16 -42
View File
@@ -1,11 +1,9 @@
import got from "got";
import type { Message, MessageDeliveryResult } from "../types.js";
import got from 'got';
import type { Message, MessageDeliveryResult } from '../types.js';
export interface RemoteTransportOptions {
timeout?: number;
retries?: number;
useHttps?: boolean;
rejectUnauthorized?: boolean;
}
export class RemoteTransport {
@@ -15,31 +13,15 @@ export class RemoteTransport {
this.options = {
timeout: options.timeout ?? 10000,
retries: options.retries ?? 2,
useHttps: options.useHttps ?? false,
rejectUnauthorized: options.rejectUnauthorized ?? true,
};
}
private getProtocol(hostAddress: string): string {
const isLocalhost =
hostAddress === "localhost" ||
hostAddress === "127.0.0.1" ||
hostAddress === "::1";
return this.options.useHttps && !isLocalhost ? "https" : "http";
}
private formatHost(hostAddress: string): string {
return hostAddress.includes(":") && !hostAddress.startsWith("[")
? `[${hostAddress}]`
: hostAddress;
}
async deliver(
message: Message,
hostAddress: string,
hostPort: number,
hostPort: number
): Promise<MessageDeliveryResult> {
const url = `${this.getProtocol(hostAddress)}://${this.formatHost(hostAddress)}:${hostPort}/message`;
const url = `http://${hostAddress}:${hostPort}/message`;
try {
const response = await got.post(url, {
@@ -47,9 +29,6 @@ export class RemoteTransport {
timeout: { request: this.options.timeout },
retry: { limit: this.options.retries },
throwHttpErrors: false,
...(this.options.useHttps && {
https: { rejectUnauthorized: this.options.rejectUnauthorized },
}),
});
if (response.statusCode === 200 || response.statusCode === 201) {
@@ -57,7 +36,7 @@ export class RemoteTransport {
messageId: message.id,
delivered: true,
deliveredAt: new Date().toISOString(),
via: "remote",
via: 'remote',
};
}
@@ -65,36 +44,34 @@ export class RemoteTransport {
messageId: message.id,
delivered: false,
error: `HTTP ${response.statusCode}: ${response.body}`,
via: "remote",
via: 'remote',
};
} catch (err: any) {
return {
messageId: message.id,
delivered: false,
error: err.message || "Connection failed",
via: "remote",
error: err.message || 'Connection failed',
via: 'remote',
};
}
}
async deliverToAgent(
message: Message,
agentAddress: string,
agentAddress: string
): Promise<MessageDeliveryResult> {
const parts = agentAddress.split("@");
const parts = agentAddress.split('@');
if (parts.length !== 2) {
return {
messageId: message.id,
delivered: false,
error: "Invalid agent address format. Expected: agentId@host:port",
via: "remote",
error: 'Invalid agent address format. Expected: agentId@host:port',
via: 'remote',
};
}
const [, hostPart] = parts;
const lastColon = hostPart.lastIndexOf(":");
const host = lastColon > 0 ? hostPart.slice(0, lastColon) : hostPart;
const portStr = lastColon > 0 ? hostPart.slice(lastColon + 1) : undefined;
const [host, portStr] = hostPart.split(':');
const port = portStr ? parseInt(portStr, 10) : 9876;
return this.deliver(message, host, port);
@@ -102,7 +79,7 @@ export class RemoteTransport {
async broadcast(
message: Message,
hosts: Array<{ address: string; port: number }>,
hosts: Array<{ address: string; port: number }>
): Promise<Map<string, MessageDeliveryResult>> {
const results = new Map<string, MessageDeliveryResult>();
@@ -110,23 +87,20 @@ export class RemoteTransport {
hosts.map(async ({ address, port }) => {
const result = await this.deliver(message, address, port);
results.set(`${address}:${port}`, result);
}),
})
);
return results;
}
async ping(hostAddress: string, hostPort: number): Promise<boolean> {
const url = `${this.getProtocol(hostAddress)}://${this.formatHost(hostAddress)}:${hostPort}/health`;
const url = `http://${hostAddress}:${hostPort}/health`;
try {
const response = await got.get(url, {
timeout: { request: 5000 },
retry: { limit: 0 },
throwHttpErrors: false,
...(this.options.useHttps && {
https: { rejectUnauthorized: this.options.rejectUnauthorized },
}),
});
return response.statusCode === 200;
+40 -49
View File
@@ -1,41 +1,36 @@
import { execFileSync } from "node:child_process";
import { existsSync, rmSync } from "node:fs";
import { join, basename } from "node:path";
import { tmpdir } from "node:os";
import { randomUUID } from "node:crypto";
import type { GitProviderAdapter, CloneOptions } from "./base.js";
import { parseShorthand } from "./base.js";
import type { GitProvider, CloneResult } from "../core/types.js";
import { discoverSkills } from "../core/skills.js";
import { execSync } from 'node:child_process';
import { existsSync, rmSync } from 'node:fs';
import { join, basename } from 'node:path';
import { tmpdir } from 'node:os';
import { randomUUID } from 'node:crypto';
import type { GitProviderAdapter, CloneOptions } from './base.js';
import { parseShorthand } from './base.js';
import type { GitProvider, CloneResult } from '../core/types.js';
import { discoverSkills } from '../core/skills.js';
export class BitbucketProvider implements GitProviderAdapter {
readonly type: GitProvider = "bitbucket";
readonly name = "Bitbucket";
readonly baseUrl = "https://bitbucket.org";
readonly type: GitProvider = 'bitbucket';
readonly name = 'Bitbucket';
readonly baseUrl = 'https://bitbucket.org';
parseSource(
source: string,
): { owner: string; repo: string; subpath?: string } | null {
if (source.startsWith("https://bitbucket.org/")) {
const path = source
.replace("https://bitbucket.org/", "")
.replace(/\.git$/, "");
parseSource(source: string): { owner: string; repo: string; subpath?: string } | null {
if (source.startsWith('https://bitbucket.org/')) {
const path = source.replace('https://bitbucket.org/', '').replace(/\.git$/, '');
return parseShorthand(path);
}
if (source.startsWith("git@bitbucket.org:")) {
const path = source
.replace("git@bitbucket.org:", "")
.replace(/\.git$/, "");
if (source.startsWith('git@bitbucket.org:')) {
const path = source.replace('git@bitbucket.org:', '').replace(/\.git$/, '');
return parseShorthand(path);
}
if (source.startsWith("bitbucket:")) {
return parseShorthand(source.replace("bitbucket:", ""));
if (source.startsWith('bitbucket:')) {
return parseShorthand(source.replace('bitbucket:', ''));
}
if (source.startsWith("bitbucket.org/")) {
return parseShorthand(source.replace("bitbucket.org/", ""));
if (source.startsWith('bitbucket.org/')) {
return parseShorthand(source.replace('bitbucket.org/', ''));
}
return null;
@@ -43,10 +38,10 @@ export class BitbucketProvider implements GitProviderAdapter {
matches(source: string): boolean {
return (
source.startsWith("https://bitbucket.org/") ||
source.startsWith("git@bitbucket.org:") ||
source.startsWith("bitbucket:") ||
source.startsWith("bitbucket.org/")
source.startsWith('https://bitbucket.org/') ||
source.startsWith('git@bitbucket.org:') ||
source.startsWith('bitbucket:') ||
source.startsWith('bitbucket.org/')
);
}
@@ -58,36 +53,31 @@ export class BitbucketProvider implements GitProviderAdapter {
return `git@bitbucket.org:${owner}/${repo}.git`;
}
async clone(
source: string,
_targetDir: string,
options: CloneOptions = {},
): Promise<CloneResult> {
async clone(source: string, _targetDir: string, options: CloneOptions = {}): Promise<CloneResult> {
const parsed = this.parseSource(source);
if (!parsed) {
return { success: false, error: `Invalid Bitbucket source: ${source}` };
}
const { owner, repo, subpath } = parsed;
const cloneUrl = options.ssh
? this.getSshUrl(owner, repo)
: this.getCloneUrl(owner, repo);
const cloneUrl = options.ssh ? this.getSshUrl(owner, repo) : this.getCloneUrl(owner, repo);
const tempDir = join(tmpdir(), `skillkit-${randomUUID()}`);
try {
const args = ["clone"];
const args = ['clone'];
if (options.depth) {
args.push("--depth", String(options.depth));
args.push('--depth', String(options.depth));
}
if (options.branch) {
args.push("--branch", options.branch);
args.push('--branch', options.branch);
}
args.push(cloneUrl, tempDir);
execFileSync("git", args, {
stdio: ["pipe", "pipe", "pipe"],
encoding: "utf-8",
execSync(`git ${args.join(' ')}`, {
stdio: ['pipe', 'pipe', 'pipe'],
encoding: 'utf-8',
});
const searchDir = subpath ? join(tempDir, subpath) : tempDir;
@@ -95,16 +85,17 @@ export class BitbucketProvider implements GitProviderAdapter {
return {
success: true,
path: searchDir,
tempRoot: tempDir,
skills: skills.map((s) => s.name),
discoveredSkills: skills.map((s) => ({
path: searchDir,
tempRoot: tempDir,
skills: skills.map(s => s.name),
discoveredSkills: skills.map(s => ({
name: s.name,
dirName: basename(s.path),
path: s.path,
})),
};
} catch (error) {
if (existsSync(tempDir)) {
rmSync(tempDir, { recursive: true, force: true });
}
+37 -43
View File
@@ -1,34 +1,31 @@
import { execFileSync } from "node:child_process";
import { existsSync, rmSync } from "node:fs";
import { join, basename } from "node:path";
import { tmpdir } from "node:os";
import { randomUUID } from "node:crypto";
import type { GitProviderAdapter, CloneOptions } from "./base.js";
import { parseShorthand, isGitUrl } from "./base.js";
import type { GitProvider, CloneResult } from "../core/types.js";
import { discoverSkills } from "../core/skills.js";
import { execSync } from 'node:child_process';
import { existsSync, rmSync } from 'node:fs';
import { join, basename } from 'node:path';
import { tmpdir } from 'node:os';
import { randomUUID } from 'node:crypto';
import type { GitProviderAdapter, CloneOptions } from './base.js';
import { parseShorthand, isGitUrl } from './base.js';
import type { GitProvider, CloneResult } from '../core/types.js';
import { discoverSkills } from '../core/skills.js';
export class GitHubProvider implements GitProviderAdapter {
readonly type: GitProvider = "github";
readonly name = "GitHub";
readonly baseUrl = "https://github.com";
readonly type: GitProvider = 'github';
readonly name = 'GitHub';
readonly baseUrl = 'https://github.com';
parseSource(
source: string,
): { owner: string; repo: string; subpath?: string } | null {
if (source.startsWith("https://github.com/")) {
const path = source
.replace("https://github.com/", "")
.replace(/\.git$/, "");
parseSource(source: string): { owner: string; repo: string; subpath?: string } | null {
if (source.startsWith('https://github.com/')) {
const path = source.replace('https://github.com/', '').replace(/\.git$/, '');
return parseShorthand(path);
}
if (source.startsWith("git@github.com:")) {
const path = source.replace("git@github.com:", "").replace(/\.git$/, "");
if (source.startsWith('git@github.com:')) {
const path = source.replace('git@github.com:', '').replace(/\.git$/, '');
return parseShorthand(path);
}
if (!isGitUrl(source) && !source.includes(":")) {
if (!isGitUrl(source) && !source.includes(':')) {
return parseShorthand(source);
}
@@ -37,9 +34,10 @@ export class GitHubProvider implements GitProviderAdapter {
matches(source: string): boolean {
return (
source.startsWith("https://github.com/") ||
source.startsWith("git@github.com:") ||
(!isGitUrl(source) && !source.includes(":") && source.includes("/"))
source.startsWith('https://github.com/') ||
source.startsWith('git@github.com:') ||
(!isGitUrl(source) && !source.includes(':') && source.includes('/'))
);
}
@@ -51,36 +49,31 @@ export class GitHubProvider implements GitProviderAdapter {
return `git@github.com:${owner}/${repo}.git`;
}
async clone(
source: string,
_targetDir: string,
options: CloneOptions = {},
): Promise<CloneResult> {
async clone(source: string, _targetDir: string, options: CloneOptions = {}): Promise<CloneResult> {
const parsed = this.parseSource(source);
if (!parsed) {
return { success: false, error: `Invalid GitHub source: ${source}` };
}
const { owner, repo, subpath } = parsed;
const cloneUrl = options.ssh
? this.getSshUrl(owner, repo)
: this.getCloneUrl(owner, repo);
const cloneUrl = options.ssh ? this.getSshUrl(owner, repo) : this.getCloneUrl(owner, repo);
const tempDir = join(tmpdir(), `skillkit-${randomUUID()}`);
try {
const args = ["clone"];
const args = ['clone'];
if (options.depth) {
args.push("--depth", String(options.depth));
args.push('--depth', String(options.depth));
}
if (options.branch) {
args.push("--branch", options.branch);
args.push('--branch', options.branch);
}
args.push(cloneUrl, tempDir);
execFileSync("git", args, {
stdio: ["pipe", "pipe", "pipe"],
encoding: "utf-8",
execSync(`git ${args.join(' ')}`, {
stdio: ['pipe', 'pipe', 'pipe'],
encoding: 'utf-8',
});
const searchDir = subpath ? join(tempDir, subpath) : tempDir;
@@ -88,16 +81,17 @@ export class GitHubProvider implements GitProviderAdapter {
return {
success: true,
path: searchDir,
tempRoot: tempDir,
skills: skills.map((s) => s.name),
discoveredSkills: skills.map((s) => ({
path: searchDir,
tempRoot: tempDir,
skills: skills.map(s => s.name),
discoveredSkills: skills.map(s => ({
name: s.name,
dirName: basename(s.path),
path: s.path,
})),
};
} catch (error) {
if (existsSync(tempDir)) {
rmSync(tempDir, { recursive: true, force: true });
}
+40 -47
View File
@@ -1,39 +1,36 @@
import { execFileSync } from "node:child_process";
import { existsSync, rmSync } from "node:fs";
import { join, basename } from "node:path";
import { tmpdir } from "node:os";
import { randomUUID } from "node:crypto";
import type { GitProviderAdapter, CloneOptions } from "./base.js";
import { parseShorthand } from "./base.js";
import type { GitProvider, CloneResult } from "../core/types.js";
import { discoverSkills } from "../core/skills.js";
import { execSync } from 'node:child_process';
import { existsSync, rmSync } from 'node:fs';
import { join, basename } from 'node:path';
import { tmpdir } from 'node:os';
import { randomUUID } from 'node:crypto';
import type { GitProviderAdapter, CloneOptions } from './base.js';
import { parseShorthand } from './base.js';
import type { GitProvider, CloneResult } from '../core/types.js';
import { discoverSkills } from '../core/skills.js';
export class GitLabProvider implements GitProviderAdapter {
readonly type: GitProvider = "gitlab";
readonly name = "GitLab";
readonly baseUrl = "https://gitlab.com";
readonly type: GitProvider = 'gitlab';
readonly name = 'GitLab';
readonly baseUrl = 'https://gitlab.com';
parseSource(
source: string,
): { owner: string; repo: string; subpath?: string } | null {
if (source.startsWith("https://gitlab.com/")) {
const path = source
.replace("https://gitlab.com/", "")
.replace(/\.git$/, "");
parseSource(source: string): { owner: string; repo: string; subpath?: string } | null {
if (source.startsWith('https://gitlab.com/')) {
const path = source.replace('https://gitlab.com/', '').replace(/\.git$/, '');
return parseShorthand(path);
}
if (source.startsWith("git@gitlab.com:")) {
const path = source.replace("git@gitlab.com:", "").replace(/\.git$/, "");
if (source.startsWith('git@gitlab.com:')) {
const path = source.replace('git@gitlab.com:', '').replace(/\.git$/, '');
return parseShorthand(path);
}
if (source.startsWith("gitlab:")) {
return parseShorthand(source.replace("gitlab:", ""));
if (source.startsWith('gitlab:')) {
return parseShorthand(source.replace('gitlab:', ''));
}
if (source.startsWith("gitlab.com/")) {
return parseShorthand(source.replace("gitlab.com/", ""));
if (source.startsWith('gitlab.com/')) {
return parseShorthand(source.replace('gitlab.com/', ''));
}
return null;
@@ -41,10 +38,10 @@ export class GitLabProvider implements GitProviderAdapter {
matches(source: string): boolean {
return (
source.startsWith("https://gitlab.com/") ||
source.startsWith("git@gitlab.com:") ||
source.startsWith("gitlab:") ||
source.startsWith("gitlab.com/")
source.startsWith('https://gitlab.com/') ||
source.startsWith('git@gitlab.com:') ||
source.startsWith('gitlab:') ||
source.startsWith('gitlab.com/')
);
}
@@ -56,36 +53,31 @@ export class GitLabProvider implements GitProviderAdapter {
return `git@gitlab.com:${owner}/${repo}.git`;
}
async clone(
source: string,
_targetDir: string,
options: CloneOptions = {},
): Promise<CloneResult> {
async clone(source: string, _targetDir: string, options: CloneOptions = {}): Promise<CloneResult> {
const parsed = this.parseSource(source);
if (!parsed) {
return { success: false, error: `Invalid GitLab source: ${source}` };
}
const { owner, repo, subpath } = parsed;
const cloneUrl = options.ssh
? this.getSshUrl(owner, repo)
: this.getCloneUrl(owner, repo);
const cloneUrl = options.ssh ? this.getSshUrl(owner, repo) : this.getCloneUrl(owner, repo);
const tempDir = join(tmpdir(), `skillkit-${randomUUID()}`);
try {
const args = ["clone"];
const args = ['clone'];
if (options.depth) {
args.push("--depth", String(options.depth));
args.push('--depth', String(options.depth));
}
if (options.branch) {
args.push("--branch", options.branch);
args.push('--branch', options.branch);
}
args.push(cloneUrl, tempDir);
execFileSync("git", args, {
stdio: ["pipe", "pipe", "pipe"],
encoding: "utf-8",
execSync(`git ${args.join(' ')}`, {
stdio: ['pipe', 'pipe', 'pipe'],
encoding: 'utf-8',
});
const searchDir = subpath ? join(tempDir, subpath) : tempDir;
@@ -93,16 +85,17 @@ export class GitLabProvider implements GitProviderAdapter {
return {
success: true,
path: searchDir,
tempRoot: tempDir,
skills: skills.map((s) => s.name),
discoveredSkills: skills.map((s) => ({
path: searchDir,
tempRoot: tempDir,
skills: skills.map(s => s.name),
discoveredSkills: skills.map(s => ({
name: s.name,
dirName: basename(s.path),
path: s.path,
})),
};
} catch (error) {
if (existsSync(tempDir)) {
rmSync(tempDir, { recursive: true, force: true });
}