Registry / llm-agents / claudekit-cli

claudekit-cli

JSON →
library3.41.4jsnpmunverified

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.

npm install claudekit-cli
INSTALL
IMPORT
SIG · CLAUDEKIT-CLI
C
claudekit-cli
llm-agentsjavascriptv3.41.4
Install
Import
Disk
Pass rate
0/ 6
Env Coverage0 / 6
glibc
1822
musl
1822
Install & Compatibility
Where this runs
tested against v? · npm install
Install × environment matrix
Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux
musl
node 18226 runs
build_error
glibc
node 18226 runs
build_error
Code
Verified usage

Verified import paths — ran on the pinned version, not inferred.

claudekit
npx claudekit <command>
import { claudekit } from 'claudekit-cli'
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.
create
npx claudekit create my-new-project
require('claudekit-cli').create()
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.
update
npx claudekit update
import { update } from 'claudekit-cli'
Project updates are performed by running the `update` command through the CLI, designed for command-line execution rather than module import.

Demonstrates how to programmatically execute the `claudekit create` command to bootstrap a new project.

import { execSync } from 'child_process'; const projectName = 'my-claudekit-app'; const template = 'default'; // Or 'desktop', 'web', etc. try { console.log(`Creating a new ClaudeKit project: ${projectName} using template: ${template}...`); // This simulates running the CLI command programmatically const output = execSync(`npx claudekit create ${projectName} --template ${template}`, { stdio: 'inherit' }); console.log(`Project '${projectName}' created successfully.`); console.log(` Now, navigate into your project and start developing:`) console.log(`cd ${projectName}`) console.log(`npm install`) console.log(`npm run dev`) } catch (error) { console.error(`Failed to create project: ${error.message}`); process.exit(1); }
claudekit --version
Debug
Known issues
breakingThe `claudekit-cli` requires Node.js version 18.0.0 or higher. Running with older versions will result in execution errors.
fix
Upgrade your Node.js environment to version 18.0.0 or newer using a tool like `nvm` or `fnm`.
affects: <18.0.0
gotchaThe 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.
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.
affects: >=3.x.x
gotchaWhen 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`).
fix
For consistent offline usage, perform `npm install -g claudekit-cli`. Otherwise, verify network connectivity.
affects: *
Errors
Common errors & fixes
Error: Command failed with exit code 127: npx claudekit create...
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.
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.
Error: Cannot find module '...' from 'claudekit-cli'
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.
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`.
Error: EACCES: permission denied, access '...' or 'npm ERR! Could not install packages.'
Insufficient permissions to write to global npm directories or project directories when installing packages or creating files.
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.
Upgrade
Version history
3.41.4latest on npm
Audit
Dependencies
noderequiredRuntime environment specified in 'engines' field.
Agent activity
19 hits · last 30 days
node
16
OpenAI (training)
1
Resources
claudekit-cli — npm install claudekit-cli · libregistry