https://github.com/tamada/btmeister
Detecting the build tools in use.
https://github.com/tamada/btmeister
build-tool project-analysis
Last synced: over 1 year ago
JSON representation
Detecting the build tools in use.
- Host: GitHub
- URL: https://github.com/tamada/btmeister
- Owner: tamada
- License: mit
- Created: 2022-04-19T02:45:39.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2025-03-13T01:59:25.000Z (over 1 year ago)
- Last Synced: 2025-03-13T02:36:13.280Z (over 1 year ago)
- Topics: build-tool, project-analysis
- Language: Rust
- Homepage: https://tamada.github.io/btmeister
- Size: 5.13 MB
- Stars: 1
- Watchers: 2
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# btmeister
[](https://github.com/tamada/btmeister/actions/workflows/build.yaml)
[](https://coveralls.io/github/tamada/btmeister?branch=main)
[](https://rust-reportcard.xuri.me/report/github.com/tamada/btmeister)
[](https://github.com/tamada/btmeister/releases/tag/v0.7.4)
[](https://github.com/tamada/btmeister/blob/main/LICENSE)
[](https://github.com/tamada/btmeister/pkgs/container/btmeister/)
[](https://github.com/tamada/homebrew-tap)
Detecting the build tools in use.
## :speaking_head: Description
This tool aims to detect the build tools in use for the project for surveying the share of the build tools.
The build tools build a project along with the rules defined in the build files.
The default names of the build files are fixed for each build tool.
This tool finds the build files from the specified directories, and identifies the build tools in use.
## :runner: Usage
```sh
Detecting build tools/task runners in use of the projects
Usage: btmeister [OPTIONS] [PROJECTs]...
Arguments:
[PROJECTs]... The target project paths. If "-" was given, reads from stdin.
Also, the first character was "@", read from the file eliminating "@".
This parameters accept directories and archive files.
Supported archive files: tar, tar.bz2, tar.gz, tar.xz, tar.zstd, and zip.
Options:
-D, --definition Specify the definition of the build tools.
--append-defs Specify the additional definitions of the build tools.
-i, --ignore-type Specify the ignore type. [default: default] [possible values: default, hidden, ignore, git-ignore, git-global, git-exclude]
-e, --excludes Specify the filters of excluding files or directories.
-L, --list-defs Print the build tools' definition list
-f, --format Specify the output format [default: default] [possible values: csv, default, json, markdown, xml, yaml]
-l, --level Specify the log level. [default: warn] [possible values: error, warn, info, debug, trace]
-h, --help Print help (see more with '--help')
-V, --version Print version
```
### Sample Output
```sh
$ btmeister ~/github.com/tamada/gibo-wrapper
/home/tamada/github.com/tamada/gibo-wrapper
Cargo.toml: Cargo
Dockerfile: Docker
build.rs: Cargo
.github/workflows/publish.yaml: GitHub Actions
.github/workflows/docker.yaml: GitHub Actions
.github/workflows/versionup.yaml: GitHub Actions
.github/workflows/build.yaml: GitHub Actions
$ btmeister --format json ~/github.com/tamada/gibo-wrapper | jq .
[
{
"base": "/home/tamada/github.com/tamada/gibo-wrapper",
"build-tools": [
{
"path": "Cargo.toml",
"tool-name": "Cargo"
},
{
"path": "Dockerfile",
"tool-name": "Docker"
},
{
"path": "build.rs",
"tool-name": "Cargo"
},
{
"path": ".github/workflows/publish.yaml",
"tool-name": "GitHub Actions"
},
{
"path": ".github/workflows/docker.yaml",
"tool-name": "GitHub Actions"
},
{
"path": ".github/workflows/versionup.yaml",
"tool-name": "GitHub Actions"
},
{
"path": ".github/workflows/build.yaml",
"tool-name": "GitHub Actions"
}
]
}
]
```
## :whale: Docker
[](https://github.com/tamada/btmeister/pkgs/container/btmeister/)
```sh
docker run --rm -it -v $PWD:/app ghcr.io/tamada/btmeister:latest .
```
* Container OS
* Working directory: `/app`
* entry point: `/opt/btmeister/btmeister`
* user: `nonroot`
## :hammer_and_wrench: Related Tools
* [Licensee](https://github.com/licensee/licensee)
* License detector for the projects.
* [linguist](https://github.com/github/linguist)
* Programming languages detector for the projects.