https://github.com/chenasraf/btool
A build helper for Dart/Flutter projects.
https://github.com/chenasraf/btool
build cli dart flutter pubspec tooling version
Last synced: 3 months ago
JSON representation
A build helper for Dart/Flutter projects.
- Host: GitHub
- URL: https://github.com/chenasraf/btool
- Owner: chenasraf
- License: mit
- Created: 2022-12-07T16:19:45.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2023-11-30T16:14:56.000Z (over 1 year ago)
- Last Synced: 2025-01-21T22:11:24.318Z (5 months ago)
- Topics: build, cli, dart, flutter, pubspec, tooling, version
- Language: Dart
- Homepage: https://pub.dev/packages/btool
- Size: 29.3 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# btool
A build helper for Dart/Flutter projects.
Contains utility for getting/setting various configs such as package version/name, min/target sdk
version, etc. through a command-line or Dart import which you can utilize for your build steps.
---
Table of Contents
- [btool](#btool)
- [Getting started](#getting-started)
- [Usage](#usage)
- [Dart](#dart)
- [Command line](#command-line)
- [Commands](#commands)
- [Available keys](#available-keys)
- [Optional flags](#optional-flags)
- [Contributing](#contributing)
---
## Getting started
See [Installing](https://pub.dev/packages/btool/install)
You can install globally, or locally as a dependency.
To see usage help, see below or use `dart run btool -h`.
## Usage
### Dart
See [API Reference](https://pub.dev/documentation/btool/latest/)
### Command line
```txt
Usage: btool [...args]
```
#### Commands
| Command | Parameters | Description |
| ------- | --------------- | ---------------- |
| `get` | `` | Get config value |
| `set` | ` ` | Set config value |
#### Available keys
| Key | Source |
| ---------------- | -------------------------- |
| applicationId | `android/app/build.gradle` |
| minSdkVersion | `android/app/build.gradle` |
| targetSdkVersion | `android/app/build.gradle` |
| packageVersion | `pubspec.yaml` |
| packageName | `pubspec.yaml` |
#### Optional flags
```txt
-h, --help Show help
-v, --version Show version
-d, --working-dir Change working directory of script
-V, --verbose Display debug output
```
#### Example
Here is an example for a simple script that pushes the apk to the device Download folder.
```sh
#!/usr/bin/env sh
name=$(dart run btool get packageName)
version=$(dart run btool get packageVersion)
source="$(pwd)/build/app/outputs/flutter-apk/app-release.apk"
target="/sdcard/Download/$name-$version.apk"
echo "adb push $source $target"
adb push $source $target
```
## Contributing
I am developing this package on my free time, so any support, whether code, issues, or just stars is
very helpful to sustaining its life. If you are feeling incredibly generous and would like to donate
just a small amount to help sustain this project, I would be very very thankful!
I welcome any issues or pull requests on GitHub. If you find a bug, or would like a new feature,
don't hesitate to open an appropriate issue and I will do my best to reply promptly.
If you are a developer and want to contribute code, here are some starting tips:
1. Fork this repository
2. Run `dart pub get`
3. Make any changes you would like
4. Create tests for your changes
5. Update the relevant documentation (readme, code comments)
6. Create a PR on upstream