Skip to content

Commands

Available Commands

new

Create a new React Native app using the app template.

ok-cli new <app-name>

Arguments: - app-name: Name of the app to create

Example:

ok-cli new MyApp

generate

Generate components, services, or pages using predefined templates.

ok-cli generate <type> <name>

Arguments: - type: Type of item to generate (component, service, page) - name: Name of the item to generate

Examples:

# Generate a component
ok-cli generate component Button

# Generate a service
ok-cli generate service ApiService

# Generate a page
ok-cli generate page HomePage

Global Options

--help

Show help information for any command.

ok-cli --help
ok-cli new --help
ok-cli generate --help

--version

Show the version of OK CLI.

ok-cli --version

Exit Codes

  • 0: Success
  • 1: Error occurred

Error Handling

The CLI provides clear error messages for common issues:

  • Invalid template type
  • Template not found
  • File system permissions
  • Missing dependencies

Template System

OK CLI uses Copier for template processing, which supports:

  • Variable substitution ({{variable}})
  • Conditional blocks
  • File and directory templating
  • Custom hooks and filters