-
Notifications
You must be signed in to change notification settings - Fork 2
Add relayburn install wrapper so npm i -g relayburn exposes burn
#150
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
9bed930
Add `relayburn` install wrapper so `npm i -g relayburn` exposes `burn`
willwashburn f256bd7
docs: update AGENTS.md and CHANGELOG.md for the relayburn wrapper
willwashburn 87143ab
chore: align relayburn wrapper baseline with @relayburn/cli@0.34.0
willwashburn 1596ecc
docs: fix stale "five packages" reference in AGENTS.md changelog section
willwashburn File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| # Changelog | ||
|
|
||
| All notable changes to `relayburn` will be documented in this file. | ||
|
|
||
| The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), | ||
| and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). | ||
|
|
||
| ## [Unreleased] | ||
|
|
||
| ### Added | ||
|
|
||
| - Initial release. Thin wrapper around [`@relayburn/cli`](https://www.npmjs.com/package/@relayburn/cli) — installing `relayburn` globally exposes the same `burn` command. Lets users `npm i -g relayburn` without needing to know the scoped package name. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| # relayburn | ||
|
|
||
| Install the [`burn`](https://github.com/AgentWorkforce/burn) CLI globally: | ||
|
|
||
| ```sh | ||
| npm i -g relayburn | ||
| ``` | ||
|
|
||
| This is a thin wrapper that depends on [`@relayburn/cli`](https://www.npmjs.com/package/@relayburn/cli) and exposes the `burn` command. Both names produce the same binary; pick whichever you find easier to type. | ||
|
|
||
| ```sh | ||
| burn --help | ||
| burn summary --since 7d | ||
| burn limits --watch | ||
| ``` | ||
|
|
||
| See the project [README](https://github.com/AgentWorkforce/burn#readme) for full documentation. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| #!/usr/bin/env node | ||
| import '@relayburn/cli/dist/cli.js'; |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,32 @@ | ||
| { | ||
| "name": "relayburn", | ||
|
devin-ai-integration[bot] marked this conversation as resolved.
|
||
| "version": "0.34.0", | ||
| "description": "Token usage & cost attribution for agent CLIs (installs the `burn` command)", | ||
| "type": "module", | ||
| "bin": { | ||
| "burn": "./bin/burn.js" | ||
| }, | ||
| "files": [ | ||
| "bin", | ||
| "README.md", | ||
| "CHANGELOG.md", | ||
| "package.json" | ||
| ], | ||
| "scripts": { | ||
| "build": "chmod +x bin/burn.js" | ||
| }, | ||
| "engines": { | ||
| "node": ">=22" | ||
| }, | ||
| "dependencies": { | ||
| "@relayburn/cli": "workspace:*" | ||
| }, | ||
| "repository": { | ||
| "type": "git", | ||
| "url": "https://github.com/AgentWorkforce/burn", | ||
| "directory": "packages/relayburn" | ||
| }, | ||
| "publishConfig": { | ||
| "access": "public" | ||
| } | ||
| } | ||
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.