katana_cli 2.27.0 copy "katana_cli: ^2.27.0" to clipboard
katana_cli: ^2.27.0 copied to clipboard

Command line tool for Masamune/Katana Framework. It initializes the project and initializes the services.

Masamune logo

Katana CLI

Follow on Twitter Follow on Threads Maintained with Melos

GitHub Sponsor


[GitHub] | [YouTube] | [Packages] | [Twitter] | [Threads] | [LinkedIn] | [mathru.net]


Command line interface used in the Masamune framework.

The following features are available

  • Project creation and optimization against the Masamune framework
  • Code template generation
  • Automatic code generation with build_runner
  • Other settings

Installation #

Install with the following command.

flutter pub global activate katana_cli

Check the dependencies of the commands used internally. If these do not all pass, it may not work properly.

katana doctor

How to use #

The following commands are available

katana [command] [subcommand] [optional parameters]

Help for the command is available at

katana help

Project Creation #

Execute the following command in the folder where the project was created.

The Application ID should include the ID in the reverse domain (com.test.myapplication).

katana create [Application ID(e.g. com.test.myapplication)]

Code generation #

The following commands can be used to generate each code template.

katana code [Code ID] [Optional Parameters]

Page #

Create page templates under lib/pages.

katana code page [PageName]

Collection Model #

Create a collection model under lib/models.

katana code collection [ModelName]

Document Model #

Create a document model under lib/models.

katana code document [ModelName]

Controller #

Create controllers under lib/controllers.

katana code controller [ControllerName]

For other codes, please see Help.

Automatic code generation with build_runner #

You must have build_runner installed in your project in order to run it.

flutter pub add --dev build_runner

Automatic code generation #

If you want to perform automatic code generation as a one-shot, execute the following command.

katana code generate

Code generation monitoring #

If you want to monitor code changes and automatically generate code when changes are made, execute the following command.

katana code watch

For other commands, please see Help.

GitHub Sponsors #

Sponsors are always welcome. Thank you for your support!

https://github.com/sponsors/mathrunet

2
likes
150
points
2.84k
downloads

Publisher

verified publishermathru.net

Weekly Downloads

Command line tool for Masamune/Katana Framework. It initializes the project and initializes the services.

Homepage
Repository (GitHub)
View/report issues

Documentation

API reference

License

MIT (license)

Dependencies

archive, csv, flutter_lints, html, image, katana, xml, yaml, yaml_writer

More

Packages that depend on katana_cli