mirror of
https://github.com/simstudioai/sim.git
synced 2026-10-16 06:39:56 +08:00
40 lines
1.2 KiB
TypeScript
40 lines
1.2 KiB
TypeScript
import chalk from 'chalk'
|
|
import { logo } from '../utils/logo'
|
|
|
|
/**
|
|
* Help command displays the logo and usage information
|
|
*/
|
|
export function help() {
|
|
// Display logo
|
|
console.log(logo)
|
|
|
|
// Display help text
|
|
console.log(`
|
|
${chalk.bold('USAGE')}
|
|
${chalk.cyan('simstudio')} Start Sim Studio with default settings
|
|
${chalk.cyan('simstudio start')} Start Sim Studio with options
|
|
${chalk.cyan('simstudio version')} Display version information
|
|
${chalk.cyan('simstudio help')} Show this help information
|
|
|
|
${chalk.bold('OPTIONS')}
|
|
${chalk.cyan('-p, --port <port>')} Specify port (default: 3000)
|
|
${chalk.cyan('-d, --debug')} Enable debug mode
|
|
${chalk.cyan('-v, --version')} Show version information
|
|
${chalk.cyan('-h, --help')} Show help information
|
|
|
|
${chalk.bold('EXAMPLES')}
|
|
${chalk.gray('# Start with default settings')}
|
|
${chalk.cyan('$ simstudio')}
|
|
|
|
${chalk.gray('# Start on a specific port')}
|
|
${chalk.cyan('$ simstudio start --port 8080')}
|
|
|
|
${chalk.gray('# Start with debug logging')}
|
|
${chalk.cyan('$ simstudio start --debug')}
|
|
|
|
${chalk.bold('DOCUMENTATION')}
|
|
${chalk.gray('For more information:')}
|
|
https://github.com/simstudioai/sim
|
|
`)
|
|
}
|