Disclaimer: This project is an independent, unofficial command-line interface (CLI) for interacting with the Fireblocks API. It is not affiliated with or endorsed by Fireblocks Ltd. "Fireblocks" is a registered trademark of Fireblocks Ltd.

This project is inspired by the design philosophy and usability of the AWS CLI.

This tool has been tested with:

• Python 3.11 or newer

Other versions are not officially supported. Please ensure you are using Python 3.11+ before running or contributing to this project.

You can install fireblocks-cli locally as a Python project:

git clone https://github.com/stirnetwork/fireblocks-cli.git
cd fireblocks-cli
pip install .

You can use pip.

pip install fireblocks-cli

For development, use:

pip install -e .[dev]

fireblocks-cli [COMMAND] [OPTIONS]

Examples:

fireblocks-cli configure init
fireblocks-cli configure list

To see all available commands:

fireblocks-cli --help

This CLI follows the XDG Base Directory Specification:

• Configuration: $XDG_CONFIG_HOME/fireblocks-cli/config.toml (default: ~/.config/fireblocks-cli/config.toml)
• Data: $XDG_DATA_HOME/fireblocks-cli/ (default: ~/.local/share/fireblocks-cli/)
• Cache: $XDG_CACHE_HOME/fireblocks-cli/ (default: ~/.cache/fireblocks-cli/)

This section explains how to contribute and work on the project.

Install development dependencies:

make install-dev

Run tests:

make test

Run linter:

make lint-license

Run all pre-commit hooks:

make pre-commit-refresh

Every commit in this repository must include a DCO sign-off (Signed-off-by line). This is enforced locally by a pre-commit commit-msg hook and in CI by the DCO check workflow.

Use the -s flag when committing:

git commit -s -m "Your commit message"
# or
git commit -sm "Your commit message"

Without sign-off, the commit-msg hook rejects the commit:

❌ Commit message is missing a 'Signed-off-by' line.
💡 Please use: git commit -sm "your message"

See Contributing for details on DCO.

To build an executable for distribution:

./build.sh patch  # or 'minor' or 'major'

The binary will be generated in the dist/ directory, compressed using UPX (if available).

• Licensed under MPL-2.0.

• Files include SPDX headers and author metadata.

• Please use the following before committing:

make annotate-SPD
make add-author

To change the copyright holder name inserted into source files:

1. Create a file named COPYRIGHT_HOLDER in the root of the repository, and write your name or your organization’s name in it. For example:

   echo "Your Name or Organization" > COPYRIGHT_HOLDER

   ⚠️ Note: This file is .gitignore'd and should not be committed.

2. Run make annotate-SPD (or the relevant pre-commit hook) to re-annotate modified source files with the new copyright holder name.

   • This target internally calls reuse annotate to update SPDX headers.
   • Only .py and .sh files tracked by git are affected.

   make annotate-SPD

Important: The value in COPYRIGHT_HOLDER must be under 50 characters.

Contributions are welcome!

All commits must be signed off (DCO). Use git commit -s or git commit -sm so that each commit message includes a Signed-off-by line. Unsigned commits are rejected by the pre-commit hook and by CI.

Also run the following before pushing:

pre-commit run --all-files

By signing off your commits, you certify that you wrote the code or have the right to submit it under the project's license.

To sign off a commit, use the -s flag when committing:

git commit -s -m "Your commit message"
or
git commit -sm "Your commit message"

This will append a line like the following to your commit message:

Signed-off-by: Your Name <your.email@example.com>

For more details, see the Developer Certificate of Origin.

This project is developed with support from multiple contributors. See CONTRIBUTORS.md for a full list.

This project is licensed under the Mozilla Public License 2.0.

Maintained by Shohei Kamon. Feel free to reach out for collaboration or questions!