zhi
c366958a37
- Change plugin id from 'padded-cell' to 'PaddedCell' - Update manifest and install script - OpenClaw infers plugin id from directory name
563 lines
17 KiB
JavaScript
Executable File
563 lines
17 KiB
JavaScript
Executable File
#!/usr/bin/env node
|
||
|
||
/**
|
||
* PaddedCell Plugin Installer
|
||
*
|
||
* Usage:
|
||
* node install.mjs
|
||
* node install.mjs --prefix /usr/local
|
||
* node install.mjs --build-only
|
||
* node install.mjs --skip-check
|
||
* node install.mjs --uninstall
|
||
*/
|
||
|
||
import { execSync } from 'child_process';
|
||
import { existsSync, mkdirSync, copyFileSync, chmodSync } from 'fs';
|
||
import { dirname, join, resolve } from 'path';
|
||
import { fileURLToPath } from 'url';
|
||
import { homedir, platform } from 'os';
|
||
import readline from 'readline';
|
||
|
||
const __filename = fileURLToPath(import.meta.url);
|
||
const __dirname = resolve(dirname(__filename));
|
||
|
||
// Plugin configuration
|
||
const PLUGIN_NAME = 'PaddedCell';
|
||
|
||
// Parse arguments
|
||
const args = process.argv.slice(2);
|
||
const options = {
|
||
prefix: null,
|
||
buildOnly: args.includes('--build-only'),
|
||
skipCheck: args.includes('--skip-check'),
|
||
verbose: args.includes('--verbose') || args.includes('-v'),
|
||
uninstall: args.includes('--uninstall'),
|
||
};
|
||
|
||
// Parse --prefix value
|
||
const prefixIndex = args.indexOf('--prefix');
|
||
if (prefixIndex !== -1 && args[prefixIndex + 1]) {
|
||
options.prefix = resolve(args[prefixIndex + 1]);
|
||
}
|
||
|
||
// Colors for output
|
||
const colors = {
|
||
reset: '\x1b[0m',
|
||
red: '\x1b[31m',
|
||
green: '\x1b[32m',
|
||
yellow: '\x1b[33m',
|
||
blue: '\x1b[34m',
|
||
cyan: '\x1b[36m',
|
||
};
|
||
|
||
function log(message, color = 'reset') {
|
||
console.log(`${colors[color]}${message}${colors.reset}`);
|
||
}
|
||
|
||
function logStep(step, message) {
|
||
log(`[${step}/6] ${message}`, 'cyan');
|
||
}
|
||
|
||
function logSuccess(message) {
|
||
log(` ✓ ${message}`, 'green');
|
||
}
|
||
|
||
function logWarning(message) {
|
||
log(` ⚠ ${message}`, 'yellow');
|
||
}
|
||
|
||
function logError(message) {
|
||
log(` ✗ ${message}`, 'red');
|
||
}
|
||
|
||
function exec(command, options = {}) {
|
||
const defaultOptions = {
|
||
cwd: __dirname,
|
||
stdio: options.silent ? 'pipe' : 'inherit',
|
||
encoding: 'utf8',
|
||
};
|
||
return execSync(command, { ...defaultOptions, ...options });
|
||
}
|
||
|
||
async function prompt(question) {
|
||
const rl = readline.createInterface({
|
||
input: process.stdin,
|
||
output: process.stdout,
|
||
});
|
||
return new Promise((resolve) => {
|
||
rl.question(question, (answer) => {
|
||
rl.close();
|
||
resolve(answer.trim());
|
||
});
|
||
});
|
||
}
|
||
|
||
// OpenClaw config helpers
|
||
function getOpenclawConfig(pathKey, defaultValue = undefined) {
|
||
try {
|
||
const out = execSync(`openclaw config get ${pathKey} --json 2>/dev/null || echo "undefined"`, {
|
||
encoding: 'utf8',
|
||
cwd: __dirname
|
||
}).trim();
|
||
if (out === 'undefined' || out === '') return defaultValue;
|
||
return JSON.parse(out);
|
||
} catch {
|
||
return defaultValue;
|
||
}
|
||
}
|
||
|
||
function setOpenclawConfig(pathKey, value) {
|
||
execSync(`openclaw config set ${pathKey} --json '${JSON.stringify(value)}'`, {
|
||
cwd: __dirname
|
||
});
|
||
}
|
||
|
||
function unsetOpenclawConfig(pathKey) {
|
||
try {
|
||
execSync(`openclaw config unset ${pathKey}`, { cwd: __dirname });
|
||
} catch {
|
||
// Ignore errors
|
||
}
|
||
}
|
||
|
||
// ============================================================================
|
||
// Step 1: Environment Detection
|
||
// ============================================================================
|
||
|
||
function detectEnvironment() {
|
||
logStep(1, 'Detecting environment...');
|
||
|
||
const env = {
|
||
platform: platform(),
|
||
isLinux: platform() === 'linux',
|
||
isMacOS: platform() === 'darwin',
|
||
nodeVersion: null,
|
||
goVersion: null,
|
||
openclawPath: null,
|
||
openclawDir: null,
|
||
};
|
||
|
||
// Check Node.js
|
||
try {
|
||
const version = exec('node --version', { silent: true }).trim();
|
||
env.nodeVersion = version;
|
||
logSuccess(`Node.js ${version}`);
|
||
} catch {
|
||
logError('Node.js not found');
|
||
}
|
||
|
||
// Check Go
|
||
try {
|
||
const version = exec('go version', { silent: true }).trim();
|
||
env.goVersion = version;
|
||
logSuccess(`Go ${version}`);
|
||
} catch {
|
||
logError('Go not found');
|
||
}
|
||
|
||
// Check openclaw
|
||
try {
|
||
const path = exec('which openclaw', { silent: true }).trim();
|
||
env.openclawPath = path;
|
||
logSuccess(`openclaw at ${path}`);
|
||
|
||
// Try to find openclaw config dir
|
||
const home = homedir();
|
||
const possibleDirs = [
|
||
join(home, '.openclaw'),
|
||
join(home, '.config', 'openclaw'),
|
||
'/etc/openclaw',
|
||
];
|
||
|
||
for (const dir of possibleDirs) {
|
||
if (existsSync(dir)) {
|
||
env.openclawDir = dir;
|
||
logSuccess(`openclaw config dir: ${dir}`);
|
||
break;
|
||
}
|
||
}
|
||
|
||
if (!env.openclawDir) {
|
||
env.openclawDir = join(home, '.openclaw');
|
||
logWarning(`openclaw config dir not found, will use: ${env.openclawDir}`);
|
||
}
|
||
} catch {
|
||
logWarning('openclaw CLI not found in PATH');
|
||
env.openclawDir = join(homedir(), '.openclaw');
|
||
}
|
||
|
||
return env;
|
||
}
|
||
|
||
function checkDependencies(env) {
|
||
if (options.skipCheck) {
|
||
logWarning('Skipping dependency checks');
|
||
return true;
|
||
}
|
||
|
||
logStep(2, 'Checking dependencies...');
|
||
|
||
let hasErrors = false;
|
||
|
||
if (!env.nodeVersion) {
|
||
logError('Node.js is required. Please install Node.js 18+');
|
||
hasErrors = true;
|
||
} else {
|
||
const majorVersion = parseInt(env.nodeVersion.slice(1).split('.')[0]);
|
||
if (majorVersion < 18) {
|
||
logError(`Node.js 18+ required, found ${env.nodeVersion}`);
|
||
hasErrors = true;
|
||
} else {
|
||
logSuccess(`Node.js version OK`);
|
||
}
|
||
}
|
||
|
||
if (!env.goVersion) {
|
||
logError('Go is required. Please install Go 1.22+');
|
||
hasErrors = true;
|
||
} else {
|
||
logSuccess(`Go version OK`);
|
||
}
|
||
|
||
if (hasErrors) {
|
||
log('\nPlease install missing dependencies and try again.', 'red');
|
||
process.exit(1);
|
||
}
|
||
|
||
return true;
|
||
}
|
||
|
||
// ============================================================================
|
||
// Step 3: Build Components
|
||
// ============================================================================
|
||
|
||
async function buildComponents(env) {
|
||
logStep(3, 'Building components...');
|
||
|
||
// Build pass_mgr
|
||
log(' Building pass_mgr (Go)...', 'blue');
|
||
try {
|
||
const passMgrDir = join(__dirname, 'pass_mgr');
|
||
if (!existsSync(passMgrDir)) {
|
||
throw new Error('pass_mgr directory not found');
|
||
}
|
||
|
||
exec('go mod tidy', { cwd: passMgrDir, silent: !options.verbose });
|
||
exec('go build -o dist/pass_mgr src/main.go', {
|
||
cwd: passMgrDir,
|
||
silent: !options.verbose
|
||
});
|
||
|
||
const binaryPath = join(passMgrDir, 'dist', 'pass_mgr');
|
||
if (!existsSync(binaryPath)) {
|
||
throw new Error('pass_mgr binary not found after build');
|
||
}
|
||
|
||
chmodSync(binaryPath, 0o755);
|
||
logSuccess('pass_mgr built successfully');
|
||
} catch (err) {
|
||
logError(`Failed to build pass_mgr: ${err.message}`);
|
||
throw err;
|
||
}
|
||
|
||
// Build pcexec
|
||
log(' Building pcexec (TypeScript)...', 'blue');
|
||
try {
|
||
const pcexecDir = join(__dirname, 'pcexec');
|
||
if (!existsSync(pcexecDir)) {
|
||
throw new Error('pcexec directory not found');
|
||
}
|
||
|
||
exec('npm install', { cwd: pcexecDir, silent: !options.verbose });
|
||
exec('npm run build', { cwd: pcexecDir, silent: !options.verbose });
|
||
|
||
logSuccess('pcexec built successfully');
|
||
} catch (err) {
|
||
logError(`Failed to build pcexec: ${err.message}`);
|
||
throw err;
|
||
}
|
||
|
||
// Build safe-restart
|
||
log(' Building safe-restart (TypeScript)...', 'blue');
|
||
try {
|
||
const safeRestartDir = join(__dirname, 'safe-restart');
|
||
if (!existsSync(safeRestartDir)) {
|
||
throw new Error('safe-restart directory not found');
|
||
}
|
||
|
||
exec('npm install', { cwd: safeRestartDir, silent: !options.verbose });
|
||
exec('npm run build', { cwd: safeRestartDir, silent: !options.verbose });
|
||
|
||
logSuccess('safe-restart built successfully');
|
||
} catch (err) {
|
||
logError(`Failed to build safe-restart: ${err.message}`);
|
||
throw err;
|
||
}
|
||
}
|
||
|
||
// ============================================================================
|
||
// Step 4: Install Components
|
||
// ============================================================================
|
||
|
||
async function installComponents(env) {
|
||
if (options.buildOnly) {
|
||
logStep(4, 'Skipping installation (--build-only)');
|
||
return null;
|
||
}
|
||
|
||
logStep(4, 'Installing components...');
|
||
|
||
const installDir = options.prefix || env.openclawDir;
|
||
const binDir = join(installDir, 'bin');
|
||
|
||
log(` Install directory: ${installDir}`, 'blue');
|
||
log(` Binary directory: ${binDir}`, 'blue');
|
||
log(` Plugin directory: ${__dirname}`, 'blue');
|
||
|
||
// Create bin directory
|
||
mkdirSync(binDir, { recursive: true });
|
||
|
||
// Install pass_mgr binary
|
||
log(' Installing pass_mgr binary...', 'blue');
|
||
const passMgrSource = join(__dirname, 'pass_mgr', 'dist', 'pass_mgr');
|
||
const passMgrDest = join(binDir, 'pass_mgr');
|
||
copyFileSync(passMgrSource, passMgrDest);
|
||
chmodSync(passMgrDest, 0o755);
|
||
logSuccess(`pass_mgr installed to ${passMgrDest}`);
|
||
|
||
return { passMgrPath: passMgrDest };
|
||
}
|
||
|
||
// ============================================================================
|
||
// Step 5: Configuration
|
||
// ============================================================================
|
||
|
||
async function configure(env) {
|
||
if (options.buildOnly) {
|
||
logStep(5, 'Skipping configuration (--build-only)');
|
||
return;
|
||
}
|
||
|
||
logStep(5, 'Configuration...');
|
||
|
||
const installDir = options.prefix || env.openclawDir;
|
||
const passMgrPath = join(installDir, 'bin', 'pass_mgr');
|
||
|
||
// Check if already initialized
|
||
const adminKeyDir = join(homedir(), '.pass_mgr');
|
||
const configPath = join(adminKeyDir, 'config.json');
|
||
|
||
if (existsSync(configPath)) {
|
||
logSuccess('pass_mgr already initialized');
|
||
} else {
|
||
log(' pass_mgr not initialized yet.', 'yellow');
|
||
log(` Run "${passMgrPath} admin init" manually after installation.`, 'cyan');
|
||
}
|
||
|
||
// Configure OpenClaw using openclaw config commands
|
||
log('\n Configuring OpenClaw plugin...', 'blue');
|
||
|
||
try {
|
||
// 1. Add to plugins.allow
|
||
const allowList = getOpenclawConfig('plugins.allow', []);
|
||
if (!allowList.includes(PLUGIN_NAME)) {
|
||
allowList.push(PLUGIN_NAME);
|
||
setOpenclawConfig('plugins.allow', allowList);
|
||
logSuccess(`Added '${PLUGIN_NAME}' to plugins.allow`);
|
||
} else {
|
||
log(' Already in plugins.allow', 'green');
|
||
}
|
||
|
||
// 2. Add plugin entry
|
||
const existingEntry = getOpenclawConfig(`plugins.entries.${PLUGIN_NAME}`);
|
||
const pluginEntry = {
|
||
enabled: true,
|
||
config: {
|
||
enabled: true,
|
||
passMgrPath: passMgrPath,
|
||
pluginDir: __dirname,
|
||
},
|
||
};
|
||
|
||
const plugins = getOpenclawConfig('plugins', {});
|
||
plugins.entries = plugins.entries || {};
|
||
plugins.entries[PLUGIN_NAME] = pluginEntry;
|
||
setOpenclawConfig('plugins', plugins);
|
||
|
||
if (existingEntry) {
|
||
logSuccess(`Updated ${PLUGIN_NAME} plugin entry`);
|
||
} else {
|
||
logSuccess(`Added ${PLUGIN_NAME} plugin entry`);
|
||
}
|
||
|
||
// 3. Add plugin path to plugins.load.paths
|
||
const currentPaths = getOpenclawConfig('plugins.load.paths', []);
|
||
if (!currentPaths.includes(__dirname)) {
|
||
currentPaths.push(__dirname);
|
||
setOpenclawConfig('plugins.load.paths', currentPaths);
|
||
logSuccess(`Added plugin path to plugins.load.paths`);
|
||
} else {
|
||
log(' Plugin path already in plugins.load.paths', 'green');
|
||
}
|
||
} catch (err) {
|
||
logWarning(`Failed to configure OpenClaw: ${err.message}`);
|
||
log(' Please manually configure:', 'yellow');
|
||
log(` openclaw config set plugins.allow --json '[..., "${PLUGIN_NAME}"]'`, 'cyan');
|
||
log(` openclaw config set plugins.entries.${PLUGIN_NAME}.enabled --json 'true'`, 'cyan');
|
||
log(` openclaw config set plugins.load.paths --json '[..., "${__dirname}"]'`, 'cyan');
|
||
}
|
||
}
|
||
|
||
// ============================================================================
|
||
// Step 6: Print Summary
|
||
// ============================================================================
|
||
|
||
function printSummary(env, passMgrPath) {
|
||
logStep(6, 'Installation Summary');
|
||
|
||
console.log('');
|
||
log('╔════════════════════════════════════════════════════════╗', 'cyan');
|
||
log('║ PaddedCell Installation Complete ║', 'cyan');
|
||
log('╚════════════════════════════════════════════════════════╝', 'cyan');
|
||
console.log('');
|
||
|
||
if (options.buildOnly) {
|
||
log('Build-only mode - binaries built but not installed', 'yellow');
|
||
console.log('');
|
||
log('Built artifacts:', 'blue');
|
||
log(` • pass_mgr: ${join(__dirname, 'pass_mgr', 'dist', 'pass_mgr')}`, 'reset');
|
||
log(` • pcexec: ${join(__dirname, 'pcexec', 'dist')}`, 'reset');
|
||
log(` • safe-restart: ${join(__dirname, 'safe-restart', 'dist')}`, 'reset');
|
||
} else {
|
||
log('Installed components:', 'blue');
|
||
log(` • pass_mgr binary: ${passMgrPath}`, 'reset');
|
||
log(` • Plugin location: ${__dirname}`, 'reset');
|
||
console.log('');
|
||
|
||
log('Next steps:', 'blue');
|
||
console.log('');
|
||
log('1. Initialize pass_mgr (required before first use):', 'yellow');
|
||
log(` ${passMgrPath} admin init`, 'cyan');
|
||
console.log('');
|
||
log('2. Test pass_mgr:', 'yellow');
|
||
log(` ${passMgrPath} set test_key mypass`, 'cyan');
|
||
log(` ${passMgrPath} get test_key`, 'cyan');
|
||
console.log('');
|
||
log('3. Restart OpenClaw gateway:', 'yellow');
|
||
log(' openclaw gateway restart', 'cyan');
|
||
}
|
||
|
||
console.log('');
|
||
log('For more information:', 'blue');
|
||
log(' • Documentation: https://git.hangman-lab.top/nav/PaddedCell', 'cyan');
|
||
console.log('');
|
||
}
|
||
|
||
// ============================================================================
|
||
// Uninstall
|
||
// ============================================================================
|
||
|
||
async function uninstall(env) {
|
||
logStep(1, 'Uninstalling PaddedCell...');
|
||
|
||
const installDir = options.prefix || env.openclawDir || join(homedir(), '.openclaw');
|
||
const passMgrBinary = join(installDir, 'bin', 'pass_mgr');
|
||
|
||
// Remove pass_mgr binary
|
||
if (existsSync(passMgrBinary)) {
|
||
try {
|
||
execSync(`rm -f "${passMgrBinary}"`, { silent: true });
|
||
logSuccess(`Removed ${passMgrBinary}`);
|
||
} catch (err) {
|
||
logError(`Failed to remove ${passMgrBinary}`);
|
||
}
|
||
}
|
||
|
||
// Remove OpenClaw configuration
|
||
log('\n Removing OpenClaw configuration...', 'blue');
|
||
|
||
try {
|
||
// Remove from plugins.allow
|
||
const allowList = getOpenclawConfig('plugins.allow', []);
|
||
const idx = allowList.indexOf(PLUGIN_NAME);
|
||
if (idx !== -1) {
|
||
allowList.splice(idx, 1);
|
||
setOpenclawConfig('plugins.allow', allowList);
|
||
logSuccess(`Removed '${PLUGIN_NAME}' from plugins.allow`);
|
||
}
|
||
|
||
// Remove plugin entry
|
||
unsetOpenclawConfig(`plugins.entries.${PLUGIN_NAME}`);
|
||
logSuccess(`Removed ${PLUGIN_NAME} plugin entry`);
|
||
|
||
// Remove from plugins.load.paths
|
||
const currentPaths = getOpenclawConfig('plugins.load.paths', []);
|
||
const pathIdx = currentPaths.indexOf(__dirname);
|
||
if (pathIdx !== -1) {
|
||
currentPaths.splice(pathIdx, 1);
|
||
setOpenclawConfig('plugins.load.paths', currentPaths);
|
||
logSuccess(`Removed plugin path from plugins.load.paths`);
|
||
}
|
||
} catch (err) {
|
||
logWarning(`Failed to update OpenClaw config: ${err.message}`);
|
||
}
|
||
|
||
// Check for admin key directory
|
||
const adminKeyDir = join(homedir(), '.pass_mgr');
|
||
if (existsSync(adminKeyDir)) {
|
||
log('\n⚠️ Admin key directory found:', 'yellow');
|
||
log(` ${adminKeyDir}`, 'cyan');
|
||
log(' This contains your encryption keys. Remove manually if desired.', 'yellow');
|
||
}
|
||
|
||
console.log('');
|
||
log('╔════════════════════════════════════════════════════════╗', 'cyan');
|
||
log('║ PaddedCell Uninstall Complete ║', 'cyan');
|
||
log('╚════════════════════════════════════════════════════════╝', 'cyan');
|
||
console.log('');
|
||
log('Restart OpenClaw gateway:', 'yellow');
|
||
log(' openclaw gateway restart', 'cyan');
|
||
}
|
||
|
||
// ============================================================================
|
||
// Main
|
||
// ============================================================================
|
||
|
||
async function main() {
|
||
console.log('');
|
||
log('╔════════════════════════════════════════════════════════╗', 'cyan');
|
||
log('║ PaddedCell Plugin Installer v0.1.0 ║', 'cyan');
|
||
log('╚════════════════════════════════════════════════════════╝', 'cyan');
|
||
console.log('');
|
||
|
||
try {
|
||
const env = detectEnvironment();
|
||
|
||
// Handle uninstall
|
||
if (options.uninstall) {
|
||
await uninstall(env);
|
||
process.exit(0);
|
||
}
|
||
|
||
checkDependencies(env);
|
||
await buildComponents(env);
|
||
const result = await installComponents(env);
|
||
await configure(env);
|
||
printSummary(env, result?.passMgrPath);
|
||
process.exit(0);
|
||
} catch (err) {
|
||
console.log('');
|
||
log('╔════════════════════════════════════════════════════════╗', 'red');
|
||
log('║ Installation Failed ║', 'red');
|
||
log('╚════════════════════════════════════════════════════════╝', 'red');
|
||
console.log('');
|
||
log(`Error: ${err.message}`, 'red');
|
||
if (options.verbose) {
|
||
console.log(err.stack);
|
||
}
|
||
process.exit(1);
|
||
}
|
||
}
|
||
|
||
main();
|