// readme

Sidekick

Dart CLI generator for Flutter and Dart apps - extend your project with custom tasks, add a sidekick to your app.

Write your automation scripts in Dart - a language all your coworkers are comfortable with - while fully supporting debugging and testing without losing the simplicity of executing shell scripts.

Awesome examples

  • Deployment scripts with multi-dimension build flavors
  • Bump the version of your packages at once
  • Generate release notes by combining merged PRs and completed JIRA issues
  • Fix broken generated build_runner code while waiting for a fix to be merged
  • Update GraphQL schemas
  • Create init scripts for coworkers to set up their environment

Getting Started

Create your first CLI

Install the CLI generator sidekick. This is only required for generation, not for the execution of the CLI.

dart pub global activate sidekick

Initialize project

sidekick init <path-to-repo> 

Follow the instructions and you just created your first sidekick CLI. You can execute your CLI right away using its entrypoint and use any of the existing tasks.

Assuming your CLI is called flg (short for flutter gallery), execute the flgโ€ฆ