https://github.com/battis/qui-cli
Tools for quickly building a CLI app
https://github.com/battis/qui-cli
cli shell terminal
Last synced: about 2 months ago
JSON representation
Tools for quickly building a CLI app
- Host: GitHub
- URL: https://github.com/battis/qui-cli
- Owner: battis
- License: gpl-3.0
- Created: 2023-06-18T02:16:25.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-05-13T01:09:41.000Z (about 2 years ago)
- Last Synced: 2024-05-13T02:26:44.154Z (about 2 years ago)
- Topics: cli, shell, terminal
- Language: TypeScript
- Homepage:
- Size: 464 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# @qui-cli/qui-cli
A collection of packages for rapidly developing command line applications
- [@qui-cli/qui-cli](./packages/qui-cli/): bundled core functionality (colors, env, log, progress, root, shell, validators). Works well with [ora](https://www.npmjs.com/package/ora) and [@inquirer/prompts](https://www.npmjs.com/package/@inquirer/prompts).
Alternatively, individual packages can be selected and used in a more parsimonious, light-weight, modular manner:
- [@qui-cli/colors](./packages/colors/): ANSI colors with [Chalk](https://www.npmjs.com/package/chalk)
- [@qui-cli/env](./packages/env/): .env file management with [dotenv](https://www.npmjs.com/package/dotenv)
- [@qui-cli/log](./packages/log/): Logging with [winston](https://www.npmjs.com/package/winston)
- [@qui-cli/progress](./packages/progress/): Progress bars with [cli-progress](https://www.npmjs.com/package/cli-progress)
- [@qui-cli/root](./packages/root/): Package root detection with [app-root-path](https://www.npmjs.com/package/app-root-path)
- [@qui-cli/shell](./packages/shell/): Shell execution with [shelljs](https://www.npmjs.com/package/shelljs))
- [@qui-cli/structured](./packages/structured/): Build a structured command from directory contents
- [@qui-cli/validators](./packages/validators/): Validate input from [@inquirer/prompts](https://www.npmjs.com/package/@inquirer/prompts)
If using the modular approach, plugin definitions are managed by [@qui-cli/plugin](./packages/plugin/) and core functionality resides in [@qui-cli/core](./packages/core/)
[Examples of usage and development approaches are available.](./examples#readme)