Finch CLI

Finch provides a command-line interface (CLI) for managing and interacting with your Finch applications. The CLI offers a range of commands to simplify common tasks, making it easier to develop, test, and deploy your applications.

In addition to the commands provided by Finch, you can also use any other Dart CLI commands. For example, you can use the dart pub get command to get the dependencies of your project. its optional to use the Finch CLI or you can use the Dart CLI directly.

Install Finch CLI

dart pub global activate finch

Run Finch CLI

To see the list of available commands, run the following command:

finch -h

Available commands:
1) create:      Make new project

      --path    Path of the project
      -p

      --name    Name of project
      -n

      --docker  Use docker
      -d
──────────────────────────────
2) get: Get pacakges of project, (dart pub get)
──────────────────────────────
3) runner:      Build runner of project, (dart pub run build_runner build)
──────────────────────────────
4) run: Run project, (dart run)

      --path    Path of app file
      -p
──────────────────────────────
5) build:       Build Project (dart compile exe)

      --appPath Path of app file
      -a

      --langPath        Languages path
      -l

      --publicPath      Public path
      -p

      --widgetPath      Widgets path
      -w

      --envPath Envitoment file (.env) path
      -e

      --output  Output path
      -o

      --type    Type of build (zip, exe)
      -t

      --help    Show the help
      -h
──────────────────────────────
6) test:        Unit test of project, (dart test)

      --reporter        Set how to print test results
      -r
──────────────────────────────


      --help    Show the help
      -h

      --version Finch Version
      -v

      --update  Update Finch
      -u
──────────────────────────────