Skip to content
This repository has been archived by the owner on Feb 21, 2024. It is now read-only.

Latest commit

 

History

History
83 lines (59 loc) · 3.81 KB

README.md

File metadata and controls

83 lines (59 loc) · 3.81 KB

Very Good Dart CLI

🚶‍♂️ Repository has moved

The Very Good Dart CLI template is now developed within the Very Good Templates repository, and can be found at very_good_templates/very_good_dart_cli.

Please file new issues on Very Good Templates.


Very Good Ventures Very Good Ventures

Developed with 💙 by Very Good Ventures 🦄

coverage style: very good analysis License: MIT

A Dart CLI template created by the Very Good Ventures Team.

Generated by the Very Good CLI 🤖

💡 Note: This README file is for a developer that wants to use Very Good Core. For contributing information please refer to the CONTRIBUTING file.


What's Included ✨

This repository contains a sample Dart CLI application containing:

  • ✅ Argument parsing
  • ✅ A sample command
  • ✅ Colorful logging
  • ✅ Automatic update prompts
  • ✅ Tab completion for bash and zsh
  • ✅ GitHub Workflow powered by [Very Good Workflows][very_good_workflows_link]
  • ✅ Strict lint rules powered by Very Good Analysis
  • ✅ Dependabot Integration
  • ✅ 100% Test Coverage
  • ✅ Fully Documented Public API
  • ✅ MIT License
  • ✅ Changelog

This Dart CLI application serves as base for the Mason brick template under /brick used by the Very Good CLI.

Quick Start 🚀

  1. Install a valid Flutter SDK in your local environment. Compatible Flutter SDK versions with Very Good CLI can be found within the Flutter release archive, ensure it has a Dart version compatible with Very Good CLI's Dart version constraint.

  2. Install Very Good CLI:

# 💻 Install Very Good CLI from pub.dev
dart pub global activate very_good_cli
  1. Generate a project using Very Good Dart CLI:
# 🚀 Create a new project using Very Good Dart CLI
very_good create dart_cli <project-name>

Where <project-name> is the name of your project.

💡 Note: Optionally, you can generate a project using Very Good Dart CLI with mason.