{"id":24379433,"url":"https://github.com/heroui-inc/heroui-cli","last_synced_at":"2026-06-06T05:00:27.262Z","repository":{"id":261065907,"uuid":"695614700","full_name":"heroui-inc/heroui-cli","owner":"heroui-inc","description":"⌨️ A CLI tool that unlocks seamless HeroUI integration.","archived":false,"fork":false,"pushed_at":"2026-06-06T03:02:22.000Z","size":1425,"stargazers_count":90,"open_issues_count":4,"forks_count":30,"subscribers_count":2,"default_branch":"main","last_synced_at":"2026-06-06T04:22:30.368Z","etag":null,"topics":["cli","design","heroui"],"latest_commit_sha":null,"homepage":"https://heroui.com/docs/guide/cli","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/heroui-inc.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"license","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2023-09-23T17:50:16.000Z","updated_at":"2026-06-06T03:02:23.000Z","dependencies_parsed_at":"2024-11-21T13:23:11.103Z","dependency_job_id":"f86ce94e-24c2-4b23-9fdf-f299ab318f75","html_url":"https://github.com/heroui-inc/heroui-cli","commit_stats":null,"previous_names":["nextui-org/nextui-cli","frontio-ai/heroui-cli","heroui-inc/heroui-cli"],"tags_count":46,"template":false,"template_full_name":null,"purl":"pkg:github/heroui-inc/heroui-cli","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/heroui-inc%2Fheroui-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/heroui-inc%2Fheroui-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/heroui-inc%2Fheroui-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/heroui-inc%2Fheroui-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/heroui-inc","download_url":"https://codeload.github.com/heroui-inc/heroui-cli/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/heroui-inc%2Fheroui-cli/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33969883,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-06T02:00:07.033Z","response_time":107,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cli","design","heroui"],"created_at":"2025-01-19T07:08:18.707Z","updated_at":"2026-06-06T05:00:27.248Z","avatar_url":"https://github.com/heroui-inc.png","language":"TypeScript","funding_links":[],"categories":["TypeScript"],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://heroui.com\"\u003e\n      \u003cimg width=\"20%\" src=\"https://raw.githubusercontent.com/heroui-inc/heroui/v3/apps/docs/public/icons/readme-logo.png\" alt=\"heroui (previously nextui)\" /\u003e\n      \u003ch1 align=\"center\"\u003eHeroUI CLI\u003c/h1\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\u003c/br\u003e\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://github.com/heroui-inc/heroui-cli/blob/main/license\"\u003e\n    \u003cimg src=\"https://img.shields.io/npm/l/heroui-cli?style=flat\" alt=\"License\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://www.npmjs.com/package/heroui-cli\"\u003e\n    \u003cimg src=\"https://img.shields.io/npm/dm/heroui-cli.svg?style=flat-round\" alt=\"npm downloads\"\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\nThe CLI offers a suite of commands to initialize, manage, and improve your HeroUI projects. It enables you to `install`, `uninstall`, or `upgrade` HeroUI packages, assess the health of your project, and more.\n\n## Quick Start\n\n\u003e **Note**: The HeroUI CLI requires [Node.js](https://nodejs.org/en) _22+_ or later\n\nYou can choose the following ways to start the HeroUI CLI.\n\n### Npx\n\n```bash\nnpx heroui-cli@latest\n```\n\n### Global Installation\n\n```bash\nnpm install -g heroui-cli\n```\n\n## Usage\n\n```bash\nUsage: heroui [command]\n\nOptions:\n  -v, --version                  Output the current version\n  --no-cache                     Disable cache, by default data will be cached for 30m after the first request\n  -d, --debug                    Debug mode will not install dependencies\n  -h --help                      Display help information for commands\n\nCommands:\n  init [options] [projectName]   Initializes a new project\n  install [options]              Installs @heroui/react and @heroui/styles in your project\n  upgrade [options]              Upgrades @heroui/react and @heroui/styles to the latest versions\n  uninstall [options]            Uninstalls @heroui/react and @heroui/styles from the project\n  list [options]                 Lists installed HeroUI packages (@heroui/react, @heroui/styles)\n  env [options]                  Displays debugging information for the local environment\n  doctor [options]               Checks for issues in the project\n  agents-md [options]            Downloads HeroUI documentation for AI coding agents\n  help [command]                 Display help for command\n```\n\n## Analytics\n\nThe `agents-md` command collects anonymous usage data.\n\n**What we collect:** Selection (react/native/both), output file names, duration, success or error. No file paths, or project contents are collected.\n\n**Opt out:** Set `HEROUI_ANALYTICS_DISABLED=1` in your environment or shell profile.\n\n## Commands\n\n### Init\n\nInitialize a new HeroUI project with official templates.\n\n```bash\nheroui init [projectName] [options]\n```\n\n#### Init Options\n\n- `-t --template [string]` The template to use for the new project e.g. app, pages, vite\n- `-p --package [string]` The package manager to use for the new project\n\n##### Example\n\n```bash\n# Initialize a new HeroUI project with the app template, named my-heroui-app using pnpm\nheroui init my-heroui-app -t app -p pnpm\n```\n\nAlternatively, you can run `init` without any flags and select an option from the prompt.\n\n```bash\nheroui init\n```\n\noutput:\n\n```bash\nHeroUI CLI \u003cversion\u003e\n\n┌  Create a new project\n│\n◇  Select a template (Enter to select)\n│  ● App (A Next.js 16 with app directory template pre-configured with HeroUI (v3) and Tailwind CSS.)\n│  ○ Pages (A Next.js 16 with pages directory template pre-configured with HeroUI (v3) and Tailwind CSS.)\n│  ○ Vite (A Vite template pre-configured with HeroUI (v3) and Tailwind CSS.)\n│\n◇  New project name (Enter to skip with default name)\n│  my-heroui-app\n│\n◇  Select a package manager (Enter to select)\n│  ● npm\n│  ○ yarn\n│  ○ pnpm\n│  ○ bun\n│\n◇  Template created successfully!\n│\n◇  Next steps ───────╮\n│                    │\n│  cd my-heroui-app  │\n│  npm install       │\n│                    │\n├────────────────────╯\n│\n└  🚀 Get started with npm run dev\n```\n\n### Install\n\nInstall `@heroui/react` and `@heroui/styles` in your project, along with their peer dependencies. If they are already installed, the command does nothing.\n\n```bash\nheroui install [options]\n```\n\n#### Install Options\n\n- `-p --packagePath` [string] The path to the package.json file\n\n##### Example\n\n```bash\nheroui install\n```\n\nOutput:\n\n```bash\nHeroUI CLI \u003cversion\u003e\n\n📦 Packages to be installed:\n╭─────────────────────────────────────────────────────────────────────────────╮\n│   Package          │   Version        │   Status   │   Docs                 │\n│─────────────────────────────────────────────────────────────────────────────│\n│   @heroui/react    │   3.0.0          │   stable   │   https://heroui.com   │\n│   @heroui/styles   │   3.0.0          │   stable   │   https://heroui.com   │\n╰─────────────────────────────────────────────────────────────────────────────╯\n\n╭─────────────── PeerDependencies ────────────────╮\n│  react@18.3.1                      latest       │\n│  react-dom@18.3.1                  latest       │\n│  tailwindcss@4.2.2                 latest       │\n╰─────────────────────────────────────────────────╯\n? Proceed with installation? › - Use arrow-keys. Return to submit.\n❯   Yes\n    No\n\n✅ @heroui/react and @heroui/styles installed successfully\n```\n\n### Upgrade\n\nUpgrade `@heroui/react` and `@heroui/styles` with their peer dependencies to the latest versions.\n\n```bash\nheroui upgrade [options]\n```\n\n#### Upgrade Options\n\n- `-p --packagePath` [string] The path to the package.json file\n\n##### Example\n\n```bash\nheroui upgrade\n```\n\nOutput:\n\n```bash\nHeroUI CLI \u003cversion\u003e\n\n╭──────────────────────────── Upgrade ────────────────────────────╮\n│  @heroui/react               ^3.0.0  -\u003e  ^3.1.0                │\n│  @heroui/styles              ^3.0.0  -\u003e  ^3.1.0                │\n╰─────────────────────────────────────────────────────────────────╯\n\n? Would you like to proceed with the upgrade? › - Use arrow-keys. Return to submit.\n❯   Yes\n    No\n\n✅ Upgrade complete. All packages are up to date.\n```\n\n### Uninstall\n\nUninstall `@heroui/react` and `@heroui/styles` from your project. Peer dependencies will not be deleted.\n\n```bash\nheroui uninstall [options]\n```\n\n#### Uninstall Options\n\n- `-p --packagePath` [string] The path to the package.json file\n\n##### Example\n\n```bash\nheroui uninstall\n```\n\nOutput:\n\n```bash\nHeroUI CLI \u003cversion\u003e\n\n❗️ Packages slated for uninstallation:\n╭──────────────────────────────────────────────────────────────────────────────────────╮\n│   Package          │   Version   │   Status   │   Docs                               │\n│──────────────────────────────────────────────────────────────────────────────────────│\n│   @heroui/react    │   3.0.0     │   stable   │   https://heroui.com                 │\n│   @heroui/styles   │   3.0.0     │   stable   │   https://heroui.com                 │\n╰──────────────────────────────────────────────────────────────────────────────────────╯\n? Confirm uninstallation of these packages: › - Use arrow-keys. Return to submit.\n❯   Yes\n    No\n\n✅ Successfully uninstalled: @heroui/react, @heroui/styles\n```\n\n### List\n\nList the installed HeroUI packages (`@heroui/react`, `@heroui/styles`).\n\n```bash\nheroui list [options]\n```\n\n#### List Options\n\n- `-p --packagePath` [string] The path to the package.json file\n\n##### Example\n\n```bash\nheroui list\n```\n\nOutput:\n\n```bash\nHeroUI CLI \u003cversion\u003e\n\nCurrent installed packages:\n\n╭──────────────────────────────────────────────────────────────────────────────────────╮\n│   Package          │   Version          │   Status   │   Docs                        │\n│──────────────────────────────────────────────────────────────────────────────────────│\n│   @heroui/react    │   3.0.0 🚀latest   │   stable   │   https://heroui.com          │\n│   @heroui/styles   │   3.0.0 🚀latest   │   stable   │   https://heroui.com          │\n╰──────────────────────────────────────────────────────────────────────────────────────╯\n```\n\n### Doctor\n\nCheck for issues in your project.\n\n```bash\nheroui doctor [options]\n```\n\n#### Features\n\n\u003e 1. Check whether `@heroui/react` and `@heroui/styles` are installed\n\u003e 2. Check whether `required peer dependencies` are installed and matched minimal requirements in the project\n\n#### Doctor Options\n\n- `-p --packagePath` [string] The path to the package.json file\n\n##### Example\n\n```bash\nheroui doctor\n```\n\nOutput:\n\nIf there is a problem in your project, the `doctor` command will display the problem information.\n\n```bash\nHeroUI CLI \u003cversion\u003e\n\nHeroUI CLI: ❌ Your project has 1 issue that require attention\n\n❗️Issue 1: missingHeroUIPackages\n\nThe following HeroUI packages are not installed:\n- @heroui/styles\n\nRun `heroui install` to install them.\n```\n\nOtherwise, the `doctor` command will display the following message.\n\n```bash\nHeroUI CLI \u003cversion\u003e\n\n✅ Your project has no detected issues.\n```\n\n### Env\n\nDisplay debug information about the local environment.\n\n```bash\nheroui env [options]\n```\n\n#### Env Options\n\n- `-p --packagePath` [string] The path to the package.json file\n\n##### Example\n\n```bash\nheroui env\n```\n\nOutput:\n\n```bash\nHeroUI CLI \u003cversion\u003e\n\nCurrent installed packages:\n\n╭──────────────────────────────────────────────────────────────────────────────────────╮\n│   Package          │   Version          │   Status   │   Docs                        │\n│──────────────────────────────────────────────────────────────────────────────────────│\n│   @heroui/react    │   3.0.0 🚀latest   │   stable   │   https://heroui.com          │\n│   @heroui/styles   │   3.0.0 🚀latest   │   stable   │   https://heroui.com          │\n╰──────────────────────────────────────────────────────────────────────────────────────╯\n\nEnvironment Info:\n  System:\n    OS: darwin\n    CPU: arm64\n  Binaries:\n    Node: v25.8.1\n```\n\n### Agents-md\n\nDownload HeroUI documentation for AI coding agents (Claude, Cursor, etc.). This command downloads the latest documentation from the HeroUI repository and generates an index file that can be injected into markdown files like `AGENTS.md` or `CLAUDE.md` to help AI assistants understand your project's HeroUI setup.\n\n```bash\nheroui agents-md [options]\n```\n\n#### Features\n\n\u003e 1. Downloads latest HeroUI documentation from the `v3` branch\n\u003e 2. Supports React, Native, and Migration (v2→v3) documentation\n\u003e 3. Generates a section for the selected library (React, Native, or Migration) in the markdown file\n\u003e 4. Automatically adds `.heroui-docs/` to `.gitignore`\n\n#### Agents-md Options\n\n- `--react` [boolean] Include React docs only (one library at a time)\n- `--native` [boolean] Include Native docs only\n- `--migration` [boolean] Include HeroUI v2 to v3 migration docs only\n- `--output \u003cfile\u003e` [string] Target file path (e.g., `AGENTS.md`, `CLAUDE.md`)\n- `--ssh` [boolean] Use SSH instead of HTTPS for git clone\n\n#### Example\n\nRun the command without any flags to enter interactive mode:\n\n```bash\nheroui agents-md\n```\n\nDownload React docs to a specific file:\n\n```bash\nheroui agents-md --react --output AGENTS.md\n```\n\nDownload Native docs:\n\n```bash\nheroui agents-md --native --output CLAUDE.md\n```\n\nDownload migration docs (v2→v3):\n\n```bash\nheroui agents-md --migration --output AGENTS.md\n```\n\nUse SSH for cloning (useful if HTTPS fails):\n\n```bash\nheroui agents-md --react --ssh --output AGENTS.md\n```\n\n#### How It Works\n\n1. **Downloads Documentation**: Clones the HeroUI repository using git sparse-checkout to download only the documentation files\n2. **Generates Index**: Creates a compact index of all documentation files organized by directory\n3. **Injects into Markdown**: Injects the index into your specified markdown file (e.g., `AGENTS.md`) with special markers:\n   - `\u003c!-- HEROUI-REACT-AGENTS-MD-START --\u003e` / `\u003c!-- HEROUI-REACT-AGENTS-MD-END --\u003e` for React docs\n   - `\u003c!-- HEROUI-NATIVE-AGENTS-MD-START --\u003e` / `\u003c!-- HEROUI-NATIVE-AGENTS-MD-END --\u003e` for Native docs\n   - `\u003c!-- HEROUI-MIGRATION-AGENTS-MD-START --\u003e` / `\u003c!-- HEROUI-MIGRATION-AGENTS-MD-END --\u003e` for Migration docs\n4. **Single library**: Only one of React, Native, or Migration can be selected at a time\n\n#### File Structure\n\nAfter running the command, you'll have:\n\n```\nyour-project/\n├── .heroui-docs/          # Downloaded documentation (gitignored)\n│   ├── react/            # React documentation files (if selected)\n│   ├── native/           # Native documentation files (if selected)\n│   └── migration/        # Migration docs (v2→v3, if selected)\n├── AGENTS.md             # Your markdown file with injected index\n└── .gitignore            # Updated to include .heroui-docs/\n```\n\n#### Notes\n\n- The command always downloads the latest documentation from the `v3` branch\n- Documentation is stored in `.heroui-docs/` which is automatically added to `.gitignore`\n\n### Community\n\nWe're excited to see the community adopt HeroUI CLI, raise issues, and provide feedback.\nWhether it's a feature request, bug report, or a project to showcase, please get involved!\n\n- [Discord](https://discord.gg/9b6yyZKmH4)\n- [Twitter](https://twitter.com/hero_ui)\n- [GitHub Discussions](https://github.com/heroui-inc/heroui-cli/discussions)\n\n## Contributing\n\nContributions are always welcome!\n\nSee [CONTRIBUTING.md](https://github.com/heroui-inc/heroui-cli/blob/main/CONTRIBUTING.md) for ways to get started.\n\nPlease adhere to this project's [CODE_OF_CONDUCT](https://github.com/heroui-inc/heroui-cli/blob/main/CODE_OF_CONDUCT.md).\n\n## License\n\n[MIT](https://choosealicense.com/licenses/mit/)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fheroui-inc%2Fheroui-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fheroui-inc%2Fheroui-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fheroui-inc%2Fheroui-cli/lists"}