105 lines
1.9 KiB
Markdown
105 lines
1.9 KiB
Markdown
# @fischerx/cli
|
|
|
|
FischerX CLI - A modern full-stack development toolkit.
|
|
|
|
## Installation
|
|
|
|
```bash
|
|
npm install -g @fischerx/cli
|
|
# or
|
|
pnpm add -g @fischerx/cli
|
|
```
|
|
|
|
## Usage
|
|
|
|
### Project Management
|
|
|
|
```bash
|
|
# Initialize a new FischerX project
|
|
fischerx init my-project
|
|
|
|
# Create a new app in the monorepo
|
|
fischerx create-app my-web-app
|
|
|
|
# Create a new shared package
|
|
fischerx create-package my-utils
|
|
```
|
|
|
|
### Code Generation
|
|
|
|
```bash
|
|
# Generate a new page
|
|
fischerx generate page my-page
|
|
# or
|
|
fischerx g page my-page
|
|
|
|
# Generate a new component
|
|
fischerx generate component my-component
|
|
|
|
# Generate an API route
|
|
fischerx generate api my-api
|
|
|
|
# Generate a full module
|
|
fischerx generate module my-module
|
|
```
|
|
|
|
### Development
|
|
|
|
```bash
|
|
# Start development server
|
|
fischerx dev
|
|
|
|
# Build the project
|
|
fischerx build
|
|
|
|
# Run tests
|
|
fischerx test
|
|
|
|
# Lint the codebase
|
|
fischerx lint
|
|
```
|
|
|
|
### Deployment & Project Info
|
|
|
|
```bash
|
|
# Deploy to development environment
|
|
fischerx deploy --env dev
|
|
|
|
# Check for updates
|
|
fischerx upgrade --check
|
|
|
|
# Check project health
|
|
fischerx doctor
|
|
|
|
# Display project information
|
|
fischerx info
|
|
```
|
|
|
|
## Commands
|
|
|
|
| Command | Alias | Description |
|
|
|---------|-------|-------------|
|
|
| `init <name>` | - | Initialize a new FischerX project |
|
|
| `create-app <name>` | - | Create a new application |
|
|
| `create-package <name>` | - | Create a new shared package |
|
|
| `generate <type> <name>` | `g` | Generate code (page, component, api, module) |
|
|
| `deploy` | - | Deploy to specified environment |
|
|
| `upgrade` | - | Upgrade FischerX |
|
|
| `doctor` | - | Check project health |
|
|
| `info` | - | Display project information |
|
|
| `dev` | - | Start development server |
|
|
| `build` | - | Build the project |
|
|
| `test` | - | Run tests |
|
|
| `lint` | - | Lint the codebase |
|
|
|
|
## Options
|
|
|
|
Most commands support additional options:
|
|
|
|
- `-h, --help`: Display help information
|
|
- `-v, --version`: Output the current version
|
|
|
|
## License
|
|
|
|
MIT
|