archive-gh-me/nextui
1
0
Fork 0
mirror of https://github.com/nextui-org/nextui.git synced 2025-12-08 19:26:11 +00:00
Code Issues Projects Releases Wiki Activity

docs: sync api from heroui-cli v1.2.2 (#5111)

Browse Source 
Co-authored-by: GitHub Action <action@github.com>
This commit is contained in:
winches 2025-03-28 01:36:55 +08:00 committed by GitHub
parent 654518e8a3
commit c7188e67f6
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 11 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
apps/docs/config/routes.json
View File

@ -49,7 +49,7 @@
"keywords": "migrate, nextui, hero, heroui", "keywords": "migrate, nextui, hero, heroui",
"path": "/docs/guide/nextui-to-heroui.mdx" "path": "/docs/guide/nextui-to-heroui.mdx"
}, },
{ {
"key": "figma", "key": "figma",
"title": "Figma", "title": "Figma",
"keywords": "figma, design, ui kit", "keywords": "figma, design, ui kit",
@ -471,7 +471,8 @@
"key": "cli-api", "key": "cli-api",
"title": "HeroUI CLI", "title": "HeroUI CLI",
"keywords": "api references, heroui, api, cli", "keywords": "api references, heroui, api, cli",
"path": "/docs/api-references/cli-api.mdx" "path": "/docs/api-references/cli-api.mdx",
"updated": true
}, },
{ {
"key": "heroui-provider", "key": "heroui-provider",

12
apps/docs/content/docs/api-references/cli-api.mdx
View File

@ -34,7 +34,8 @@ Options:
Commands: Commands:
init [options] [projectName] Initializes a new project init [options] [projectName] Initializes a new project
add [options] [components...] Adds components to your project add [options] [targets...] 1. Adds components to your project
2. Adds HeroUI Chat codebase to your project
upgrade [options] [components...] Upgrades project components to the latest versions upgrade [options] [components...] Upgrades project components to the latest versions
remove [options] [components...] Removes components from the project remove [options] [components...] Removes components from the project
list [options] Lists all components, showing status, descriptions, and versions list [options] Lists all components, showing status, descriptions, and versions
@ -100,27 +101,30 @@ HeroUI CLI v0.2.1
### Add ### Add
Add HeroUI components to your project. 1. Add HeroUI components to your project.
2. Add HeroUI Chat codebase to your project.
#### Features #### Features
> 1. Auto add the missing required `dependencies` to your project > 1. Auto add the missing required `dependencies` to your project
> 2. Auto add the required `tailwindcss.config.js` configuration to your project > 2. Auto add the required `tailwindcss.config.js` configuration to your project
> 3. Detect whether using pnpm, if so, add the required configuration to your `.npmrc` file > 3. Detect whether using pnpm, if so, add the required configuration to your `.npmrc` file
> 4. Add HeroUI Chat codebase to your project
```codeBlock bash ```codeBlock bash
heroui add [components...] [options] heroui add [targets...] [options]
``` ```
#### Add Options #### Add Options
- `-a --all` [boolean] Add all the HeroUI components (default: `false`) - `-a --all` [boolean] Add all components (default: `false`)
- `-p --packagePath` [string] The path to the package.json file - `-p --packagePath` [string] The path to the package.json file
- `-tw --tailwindPath` [string] The path to the tailwind.config file file - `-tw --tailwindPath` [string] The path to the tailwind.config file file
- `-app --appPath` [string] The path to the App.tsx file - `-app --appPath` [string] The path to the App.tsx file
- `--prettier` [boolean] Add prettier format in the add content which required installed prettier - (default: `false`) - `--prettier` [boolean] Add prettier format in the add content which required installed prettier - (default: `false`)
- `--addApp` [boolean] Add App.tsx file content which required provider (default: `false`) - `--addApp` [boolean] Add App.tsx file content which required provider (default: `false`)
- `-b --beta` [boolean] Add beta components (default: `false`) - `-b --beta` [boolean] Add beta components (default: `false`)
- `-d --directory` [string] Add HeroUI Chat codebase to a specific directory
##### Example ##### Example