{"id":17526,"library":"claudekit-cli","title":"ClaudeKit CLI","description":"claudekit-cli is a command-line interface tool designed to streamline the initialization and maintenance of ClaudeKit projects. Its primary function is to bootstrap new projects using predefined boilerplate templates and facilitate updates to existing ones. The package is currently in active development, with recent releases indicating a focus on continuous integration and refinement, often denoted by 'dev' suffixes (e.g., v3.41.4-dev.45). It requires Node.js version 18.0.0 or higher to operate. As a CLI, its core utility lies in command execution rather than programmatic imports, serving as an essential tool for developers working within the ClaudeKit ecosystem to quickly set up and manage their applications, offering a consistent and automated approach to project scaffolding.","status":"active","version":"3.41.4","language":"javascript","source_language":"en","source_url":"https://github.com/mrgoonie/claudekit-cli","tags":["javascript","cli","claudekit","boilerplate","bootstrap","template"],"install":[{"cmd":"npm install claudekit-cli","lang":"bash","label":"npm"},{"cmd":"yarn add claudekit-cli","lang":"bash","label":"yarn"},{"cmd":"pnpm add claudekit-cli","lang":"bash","label":"pnpm"}],"dependencies":[{"reason":"Runtime environment specified in 'engines' field.","package":"node","optional":false}],"imports":[{"note":"This package is a CLI tool. Its primary interaction is via command-line execution using `npx` or a global installation (`npm install -g claudekit-cli`). Programmatic imports of symbols are not its intended use.","wrong":"import { claudekit } from 'claudekit-cli'","symbol":"claudekit","correct":"npx claudekit <command>"},{"note":"To initiate a new project, the `create` command is invoked directly via the CLI. It's not exposed as a JavaScript function for direct import.","wrong":"require('claudekit-cli').create()","symbol":"create","correct":"npx claudekit create my-new-project"},{"note":"Project updates are performed by running the `update` command through the CLI, designed for command-line execution rather than module import.","wrong":"import { update } from 'claudekit-cli'","symbol":"update","correct":"npx claudekit update"}],"quickstart":{"code":"import { execSync } from 'child_process';\n\nconst projectName = 'my-claudekit-app';\nconst template = 'default'; // Or 'desktop', 'web', etc.\n\ntry {\n  console.log(`Creating a new ClaudeKit project: ${projectName} using template: ${template}...`);\n  // This simulates running the CLI command programmatically\n  const output = execSync(`npx claudekit create ${projectName} --template ${template}`, {\n    stdio: 'inherit'\n  });\n  console.log(`Project '${projectName}' created successfully.`);\n\n  console.log(`\nNow, navigate into your project and start developing:`)\n  console.log(`cd ${projectName}`)\n  console.log(`npm install`)\n  console.log(`npm run dev`)\n\n} catch (error) {\n  console.error(`Failed to create project: ${error.message}`);\n  process.exit(1);\n}\n","lang":"typescript","description":"Demonstrates how to programmatically execute the `claudekit create` command to bootstrap a new project."},"warnings":[{"fix":"Upgrade your Node.js environment to version 18.0.0 or newer using a tool like `nvm` or `fnm`.","message":"The `claudekit-cli` requires Node.js version 18.0.0 or higher. Running with older versions will result in execution errors.","severity":"breaking","affected_versions":"<18.0.0"},{"fix":"Refer to the GitHub repository for the most up-to-date information and consider pinning to specific non-dev versions if stability is critical for your project.","message":"The project is undergoing rapid development, with many recent releases being 'dev' versions (e.g., v3.41.4-dev.45). While this indicates active maintenance, it may also imply potential instability or frequent, undocumented minor changes.","severity":"gotcha","affected_versions":">=3.x.x"},{"fix":"For consistent offline usage, perform `npm install -g claudekit-cli`. Otherwise, verify network connectivity.","message":"When using `npx`, ensure you have an active internet connection as it will attempt to download the latest version of `claudekit-cli` if not already cached. For offline use or specific version control, consider global installation (`npm install -g claudekit-cli`).","severity":"gotcha","affected_versions":"*"}],"env_vars":null,"last_verified":"2026-04-23T00:00:00.000Z","next_check":"2026-07-22T00:00:00.000Z","problems":[{"fix":"Ensure Node.js and npm are correctly installed and their executables are accessible in your system's PATH. Try running `node -v` and `npm -v` to verify.","cause":"The `npx` command could not find or execute `claudekit`. This often indicates `npm` or `node` are not correctly installed or configured in the system's PATH.","error":"Error: Command failed with exit code 127: npx claudekit create..."},{"fix":"Try reinstalling the package: `npm uninstall -g claudekit-cli` followed by `npm install -g claudekit-cli`. If using `npx`, clear npm cache with `npm cache clean --force`.","cause":"This error typically occurs when Node.js cannot resolve an internal module dependency. This can happen if the `claudekit-cli` package was corrupted during installation or if there are conflicting node_modules.","error":"Error: Cannot find module '...' from 'claudekit-cli'"},{"fix":"Try running the command with `sudo` (on macOS/Linux: `sudo npx claudekit create...`) or fix npm permissions (search for 'fixing npm permissions' for your OS). For local project creation, ensure your user has write access to the target directory.","cause":"Insufficient permissions to write to global npm directories or project directories when installing packages or creating files.","error":"Error: EACCES: permission denied, access '...' or 'npm ERR! Could not install packages.'"}],"ecosystem":"npm","meta_description":null,"install_score":null,"install_tag":null,"quickstart_score":null,"quickstart_tag":null}