create-vincent-app
v0.0.3
Published
AI-powered app generator with beautiful CLI
Readme
[!CAUTION] > 🚧 This project is not implemented and is not working yet! 🚧
This is a work in progress and the functionality described below is not yet available.
create-vincent-app
AI-powered app generator with a beautiful CLI experience
Features
✨ AI-Powered Generation - Describe your app idea and let AI build it for you
🎨 Beautiful CLI - Interactive prompts with a delightful user experience
⚡ Fast & Easy - Get a full project structure in seconds
🚀 Ready to Run - Generated apps are ready to install and run immediately
Usage
Quick Start
Generate a new app with the interactive CLI:
npx create-vincent-appThis will:
- Ask for your project name
- Ask what you want to build
- Generate all the files using AI
- Give you next steps to run your app
CLI Commands
Generate App (Default)
npx create-vincent-appStarts the interactive app generation process.
Help
npx create-vincent-app help
# or
npx create-vincent-app --help
npx create-vincent-app -hShows the help message with all available commands.
Version
npx create-vincent-app version
# or
npx create-vincent-app --version
npx create-vincent-app -vDisplays the current version of the CLI.
Info
npx create-vincent-app infoShows detailed information about the CLI tool, including features, author, and links.
Example
$ npx create-vincent-app
┌ create-vincent-app
│
◇ What would you like to name your project?
│ my-todo-app
│
◇ What do you want to build?
│ A todo app with authentication and dark mode support
│
◇ Generating your app with AI...
│ Writing files... (12 files)
│
└ App generated successfully! 🎉
Next steps:
cd my-todo-app
npm install
npm run dev
Problems? https://terminalhq.com/helpRequirements
- Node.js 16.x or higher
- npm or yarn
Development
This is a monorepo containing two packages:
packages/create-vincent-app- Main CLI packagepackages/create-my-vincent-app- Alias package that forwards to the main one
Install Dependencies
npm installBuild
npm run buildPublish Both Packages
To bump version and publish both packages:
# 1. Bump version in create-vincent-app
cd packages/create-vincent-app
npm version patch # or minor, major
# 2. Publish both (from root)
cd ../..
npm run publish:allThe publish:all script will:
- Build the main package
- Sync the version to the alias package
- Publish both packages to npm
API Integration
The CLI calls the Vincent API at https://api.terminalhq.com/generate with your app idea. The API streams back files which are written to your project directory.
To integrate with your own API:
- Update the API endpoint in
src/generator.ts - Modify the request/response format as needed
- Rebuild with
npm run build
License
MIT
Links
- Homepage: https://terminalhq.com
