panthyy / Inkify

A meta-framework for Ink, A React based library for building with extra features improving DX

Inkify

Inkify is a a meta-framework for Ink, A React based library for building Command line interfaces.

Checkout https://github.com/vadimdemedes/ink for ink specific documentation.

Features

• File-based routing: Easily organize and manage your CLI commands using a file-based structure, simplifying code organization and maintenance.
• Easy configuration: Configure your CLI app with ease using various methods such as JSON, YAML, or environment variables.
• Integrated testing utilities: Streamline the development process with built-in testing utilities designed specifically for Inkify-powered CLI apps.

Getting Started

To get started with Inkify, follow these simple steps:

Scaffold a new project using our helper tool

npx create-inkify-app my-cli-app

Navigate to your project directory and start building your CLI app:

cd my-cli-app

For detailed documentation on how to use Inkify, visit the official Inkify documentation.

Contributing

We welcome contributions from the community! Check out our contributing guide. for more information on how to get involved.

License

Inkify is released under the MIT License.