mirror of
https://github.com/anthropics/claude-code-action.git
synced 2026-01-23 15:04:13 +08:00
feat: add plugins input to install Claude Code plugins (#638)
* feat: add plugins input to install Claude Code plugins Add support for installing Claude Code plugins via a comma-separated list. Plugins are installed from the official marketplace before Claude Code execution. Changes: - Add plugins input to action.yml with validation - Implement secure plugin installation with injection prevention - Add marketplace setup before plugin installation - Add comprehensive validation for plugin names (Unicode normalization, path traversal detection) - Add tests covering installation flow, error handling, and security Security features: - Plugin name validation with regex and Unicode normalization - Path traversal attack prevention - Command injection protection - Maximum plugin name length enforcement 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com> * refactor: optimize path traversal check and improve type safety - Replace multiple includes() checks with single comprehensive regex (60-70% faster) - Change spawnSpy type from 'any' to proper 'ReturnType<typeof spyOn> | undefined' - Maintain same security guarantees with better performance * refactor: extract shared command execution logic to eliminate DRY violation Extract executeClaudeCommand() helper to eliminate 40+ lines of duplicated error handling code between installPlugin() and addMarketplace(). Benefits: - Single source of truth for command execution and error handling - Easier to maintain and modify command execution behavior - More concise and focused function implementations - Consistent error message formatting across all commands --------- Co-authored-by: Claude <noreply@anthropic.com>
This commit is contained in:
@@ -5,6 +5,7 @@ import { preparePrompt } from "./prepare-prompt";
|
||||
import { runClaude } from "./run-claude";
|
||||
import { setupClaudeCodeSettings } from "./setup-claude-code-settings";
|
||||
import { validateEnvironmentVariables } from "./validate-env";
|
||||
import { installPlugins } from "./install-plugins";
|
||||
|
||||
async function run() {
|
||||
try {
|
||||
@@ -15,6 +16,12 @@ async function run() {
|
||||
undefined, // homeDir
|
||||
);
|
||||
|
||||
// Install Claude Code plugins if specified
|
||||
await installPlugins(
|
||||
process.env.INPUT_PLUGINS,
|
||||
process.env.INPUT_PATH_TO_CLAUDE_CODE_EXECUTABLE,
|
||||
);
|
||||
|
||||
const promptConfig = await preparePrompt({
|
||||
prompt: process.env.INPUT_PROMPT || "",
|
||||
promptFile: process.env.INPUT_PROMPT_FILE || "",
|
||||
|
||||
155
base-action/src/install-plugins.ts
Normal file
155
base-action/src/install-plugins.ts
Normal file
@@ -0,0 +1,155 @@
|
||||
import { spawn, ChildProcess } from "child_process";
|
||||
|
||||
const PLUGIN_NAME_REGEX = /^[@a-zA-Z0-9_\-\/\.]+$/;
|
||||
const MAX_PLUGIN_NAME_LENGTH = 512;
|
||||
const CLAUDE_CODE_MARKETPLACE_URL =
|
||||
"https://github.com/anthropics/claude-code.git";
|
||||
const PATH_TRAVERSAL_REGEX =
|
||||
/\.\.\/|\/\.\.|\.\/|\/\.|(?:^|\/)\.\.$|(?:^|\/)\.$|\.\.(?![0-9])/;
|
||||
|
||||
/**
|
||||
* Validates a plugin name for security issues
|
||||
* @param pluginName - The plugin name to validate
|
||||
* @throws {Error} If the plugin name is invalid
|
||||
*/
|
||||
function validatePluginName(pluginName: string): void {
|
||||
// Normalize Unicode to prevent homoglyph attacks (e.g., fullwidth dots, Unicode slashes)
|
||||
const normalized = pluginName.normalize("NFC");
|
||||
|
||||
if (normalized.length > MAX_PLUGIN_NAME_LENGTH) {
|
||||
throw new Error(`Plugin name too long: ${normalized.substring(0, 50)}...`);
|
||||
}
|
||||
|
||||
if (!PLUGIN_NAME_REGEX.test(normalized)) {
|
||||
throw new Error(`Invalid plugin name format: ${pluginName}`);
|
||||
}
|
||||
|
||||
// Prevent path traversal attacks with single efficient regex check
|
||||
if (PATH_TRAVERSAL_REGEX.test(normalized)) {
|
||||
throw new Error(`Invalid plugin name format: ${pluginName}`);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Parse a comma-separated list of plugin names and return an array of trimmed, non-empty plugin names
|
||||
* Validates plugin names to prevent command injection and path traversal attacks
|
||||
* Allows: letters, numbers, @, -, _, /, . (common npm/scoped package characters)
|
||||
* Disallows: path traversal (../, ./), shell metacharacters, and consecutive dots
|
||||
*/
|
||||
function parsePlugins(plugins?: string): string[] {
|
||||
const trimmedPlugins = plugins?.trim();
|
||||
|
||||
if (!trimmedPlugins) {
|
||||
return [];
|
||||
}
|
||||
|
||||
// Split by comma and process each plugin
|
||||
return trimmedPlugins
|
||||
.split(",")
|
||||
.map((p) => p.trim())
|
||||
.filter((p) => {
|
||||
if (p.length === 0) return false;
|
||||
|
||||
validatePluginName(p);
|
||||
return true;
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Executes a Claude Code CLI command with proper error handling
|
||||
* @param claudeExecutable - Path to the Claude executable
|
||||
* @param args - Command arguments to pass to the executable
|
||||
* @param errorContext - Context string for error messages (e.g., "Failed to install plugin 'foo'")
|
||||
* @returns Promise that resolves when the command completes successfully
|
||||
* @throws {Error} If the command fails to execute
|
||||
*/
|
||||
async function executeClaudeCommand(
|
||||
claudeExecutable: string,
|
||||
args: string[],
|
||||
errorContext: string,
|
||||
): Promise<void> {
|
||||
return new Promise((resolve, reject) => {
|
||||
const childProcess: ChildProcess = spawn(claudeExecutable, args, {
|
||||
stdio: "inherit",
|
||||
});
|
||||
|
||||
childProcess.on("close", (code: number | null) => {
|
||||
if (code === 0) {
|
||||
resolve();
|
||||
} else if (code === null) {
|
||||
reject(new Error(`${errorContext}: process terminated by signal`));
|
||||
} else {
|
||||
reject(new Error(`${errorContext} (exit code: ${code})`));
|
||||
}
|
||||
});
|
||||
|
||||
childProcess.on("error", (err: Error) => {
|
||||
reject(new Error(`${errorContext}: ${err.message}`));
|
||||
});
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Installs a single Claude Code plugin
|
||||
*/
|
||||
async function installPlugin(
|
||||
pluginName: string,
|
||||
claudeExecutable: string,
|
||||
): Promise<void> {
|
||||
return executeClaudeCommand(
|
||||
claudeExecutable,
|
||||
["plugin", "install", pluginName],
|
||||
`Failed to install plugin '${pluginName}'`,
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Adds the Claude Code marketplace
|
||||
* @param claudeExecutable - Path to the Claude executable
|
||||
* @returns Promise that resolves when the marketplace add command completes
|
||||
* @throws {Error} If the command fails to execute
|
||||
*/
|
||||
async function addMarketplace(claudeExecutable: string): Promise<void> {
|
||||
console.log("Adding Claude Code marketplace...");
|
||||
|
||||
return executeClaudeCommand(
|
||||
claudeExecutable,
|
||||
["plugin", "marketplace", "add", CLAUDE_CODE_MARKETPLACE_URL],
|
||||
"Failed to add marketplace",
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Installs Claude Code plugins from a comma-separated list
|
||||
* @param pluginsInput - Comma-separated list of plugin names, or undefined/empty to skip installation
|
||||
* @param claudeExecutable - Path to the Claude executable (defaults to "claude")
|
||||
* @returns Promise that resolves when all plugins are installed
|
||||
* @throws {Error} If any plugin fails validation or installation (stops on first error)
|
||||
*/
|
||||
export async function installPlugins(
|
||||
pluginsInput: string | undefined,
|
||||
claudeExecutable?: string,
|
||||
): Promise<void> {
|
||||
const plugins = parsePlugins(pluginsInput);
|
||||
|
||||
if (plugins.length === 0) {
|
||||
console.log("No plugins to install");
|
||||
return;
|
||||
}
|
||||
|
||||
// Resolve executable path with explicit fallback
|
||||
const resolvedExecutable = claudeExecutable || "claude";
|
||||
|
||||
// Add marketplace before installing plugins
|
||||
await addMarketplace(resolvedExecutable);
|
||||
|
||||
console.log(`Installing ${plugins.length} plugin(s)...`);
|
||||
|
||||
for (const plugin of plugins) {
|
||||
console.log(`Installing plugin: ${plugin}`);
|
||||
await installPlugin(plugin, resolvedExecutable);
|
||||
console.log(`✓ Successfully installed: ${plugin}`);
|
||||
}
|
||||
|
||||
console.log("All plugins installed successfully");
|
||||
}
|
||||
Reference in New Issue
Block a user