README

A command-line tool for Flare — interact with the Flare API from your terminal.

Installation

composer global require spatie/flare-cli

Make sure Composer's global bin directory is in your PATH. You can find the path with:

composer global config bin-dir --absolute

Updating

composer global require spatie/flare-cli

Usage

Authentication

# Log in with your Flare API token
flare login

# Log out
flare logout

Get your API token at flareapp.io/settings/api-tokens.

Commands

Every Flare API endpoint has a corresponding command. Run flare <command> --help for details on a specific command.

flare list-projects
flare create-project --field name="My App" --field team_id=1 --field stage=production --field technology=Laravel
flare delete-project --project-id=<id>

flare list-project-errors --project-id=<id>
flare list-error-occurrences --error-id=<id>
flare get-error-occurrence --occurrence-id=<id>
flare get-project-error-count --project-id=<id> --start-date=<date> --end-date=<date>
flare get-project-error-occurrence-count --project-id=<id> --start-date=<date> --end-date=<date>

flare resolve-error --error-id=<id>
flare unresolve-error --error-id=<id>
flare snooze-error --error-id=<id>
flare unsnooze-error --error-id=<id>

flare get-team --team-id=<id>
flare remove-team-user --team-id=<id> --user-id=<id>
flare get-authenticated-user

flare get-monitoring-summary --project-id=<id>
flare list-monitoring-aggregations --project-id=<id> --type=routes
flare get-monitoring-time-series --project-id=<id> --type=routes
flare get-monitoring-aggregation --type=routes --uuid=<uuid>
flare list-aggregation-traces --type=routes --uuid=<uuid>
flare get-trace --trace-id=<trace-id>

Agent Skill

This repository includes an agent skill that teaches coding agents how to use the Flare CLI.

Install

flare install-skill

Testing

composer test

Releasing a new version

1. Build the PHAR:

   php flare app:build flare --build-version=1.x.x

   This bakes the version into builds/flare. If you omit --build-version, it will prompt you (defaulting to the latest git tag).

2. Commit and push:

   git add builds/flare
   git commit -m "Release v1.x.x"
   git push origin main

3. Create a release in the GitHub UI — this creates the tag, triggers Packagist, and automatically updates the changelog.

Users install or update with composer global require spatie/flare-cli.

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

• Alex Vanderbist
• All Contributors

License

The MIT License (MIT). Please see License File for more information.