Elegant CLI Builder
🚧 This project is under heavy development. More features are coming soon!
Install package:
# npm
npm install citty
# yarn
yarn add citty
# pnpm
pnpm install citty
Import:
// ESM
import { defineCommand, runMain } from "citty";
// CommonJS
const { defineCommand, runMain } = require("citty");
Define main command to run:
import { defineCommand, runMain } from "citty";
const main = defineCommand({
meta: {
name: "hello",
version: "1.0.0",
description: "My Awesome CLI App",
},
args: {
name: {
type: "positional",
description: "Your name",
required: true,
},
friendly: {
type: "boolean",
description: "Use friendly greeting",
},
},
run({ args }) {
console.log(`${args.friendly ? "Hi" : "Greetings"} ${args.name}!`);
},
});
runMain(main);
defineCommanddefineCommand is a type helper for defining commands.
runMainRuns a command with usage support and graceful error handling.
createMainCreate a wrapper around command that calls runMain when called.
runCommandParses input args and runs command and sub-commands (unsupervised). You can access result key from returnd/awaited value to access command's result.
parseArgsParses input arguments and applies defaults.
renderUsageRenders command usage to a string value.
showUsageRenders usage and prints to the console
corepack enablepnpm installpnpm devMade with 💛 Published under MIT License.
Argument parser is based on lukeed/mri by Luke Edwards (@lukeed).
FAQs
Elegant CLI Builder
The npm package citty receives a total of 2,500,562 weekly downloads. As such, citty popularity was classified as popular.
We found that citty demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
PyPI confirms no security flaws were exploited in the Ultralytics supply chain attack and highlights improvements for safer package publishing.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.