bruno-init-suite
is a CLI tool designed to automate the creation of Bruno documentation and integration with third-party services, including scripts and configurations. This tool simplifies the initialization of Bruno projects with custom configurations, such as using AWS Cognito for authentication.
curl -L https://github.com/rodanr/bruno-init-suite/releases/latest/download/bruno-init-suite-linux-amd64.tar.gz -o /tmp/bruno-init-suite.tar.gz
tar -xzf /tmp/bruno-init-suite.tar.gz -C ~/.local/bin
mv ~/.local/bin/bruno-init-suite-linux-amd64 ~/.local/bin/bruis
chmod a+rx ~/.local/bin/bruis
curl -L https://github.com/rodanr/bruno-init-suite/releases/latest/download/bruno-init-suite-linux-arm64.tar.gz -o /tmp/bruno-init-suite.tar.gz
tar -xzf /tmp/bruno-init-suite.tar.gz -C ~/.local/bin
mv ~/.local/bin/bruno-init-suite-linux-arm64 ~/.local/bin/bruis
chmod a+rx ~/.local/bin/bruis
curl -L https://github.com/rodanr/bruno-init-suite/releases/latest/download/bruno-init-suite-darwin-amd64.tar.gz -o /tmp/bruno-init-suite.tar.gz
tar -xzf /tmp/bruno-init-suite.tar.gz -C ~/.local/bin
mv ~/.local/bin/bruno-init-suite-darwin-amd64 ~/.local/bin/bruis
chmod a+rx ~/.local/bin/bruis
curl -L https://github.com/rodanr/bruno-init-suite/releases/latest/download/bruno-init-suite-darwin-arm64.tar.gz -o /tmp/bruno-init-suite.tar.gz
tar -xzf /tmp/bruno-init-suite.tar.gz -C ~/.local/bin
mv ~/.local/bin/bruno-init-suite-darwin-arm64 ~/.local/bin/bruis
chmod a+rx ~/.local/bin/bruis
Download the latest release from GitHub, unzip it, and rename the executable to bruis.exe
. Add the executable to your system's PATH.
Download the latest release from GitHub, unzip it, and rename the executable to bruis.exe
. Add the executable to your system's PATH.
Run the CLI tool with the following commands and options:
- init: Initialize a new Bruno project with custom configurations.
- version: Show the version of Bruno Init Suite.
- --output, -o: Output directory for generated Bruno docs.
- --version, -v: Show version of Bruno Init Suite.
The init
command initializes a new Bruno project in the specified output directory with optional configurations.
bruis init [flags]
- --cognito, -c: Use AWS Cognito for authentication (default: false).
- --name, -n: Name of the project (default: "bruno-docs").
- --baseUrl, -b: Base URL for the project (default: "http://localhost:8080").
Initialize a new Bruno project named "my-bruno-docs" with AWS Cognito authentication and a custom base URL:
mkdir my-bruno-docs
cd my-bruno-docs
bruis init -c -n my-bruno-docs -b https://api.example.com
or
bruis init -c -n my-bruno-docs -b https://api.example.com -o my-bruno-docs
This command will generate the necessary Bruno documentation files and configurations in the specified output directory.
The generated project will have the following structure:
<output-dir>/
├── bruno.json
├── collection.bru
├── .env.example
├── environments/
│ └── environment.bru
└── lib/
└── cognito-auth.js (if --cognito is specified)
We welcome contributions to improve this project! If you encounter any issues, have suggestions for features, or want to contribute in any way, please feel free to create a GitHub issue.
For tutorials and more information, check out our YouTube Channel.