Skip to content

Commit 2eea4ef

Browse files
committed
docs: replace emoji required indicators with yes/no in inputs table
Made-with: Cursor
1 parent 5afbf68 commit 2eea4ef

1 file changed

Lines changed: 22 additions & 22 deletions

File tree

README.md

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -297,25 +297,25 @@ Replace `$INPUT_TOKENS` etc. with however your agent exposes token counts (step
297297

298298
| Input | Required | Default | Description |
299299
|-------|----------|---------|-------------|
300-
| `api_key` | | — | Your AgentMeter API key (`am_sk_…`). Get it from [agentmeter.app/dashboard/settings](https://agentmeter.app/dashboard/settings). |
301-
| `model` | | `''` | The AI model used (e.g. `claude-sonnet-4-5`). Used for per-token cost display. |
302-
| `engine` | | `claude` | The AI engine (`claude`, `codex`). |
303-
| `status` | | `success` | Run outcome. In companion `workflow_run` mode this is resolved automatically from the triggering workflow's conclusion. In inline mode pass `${{ steps.agent.outcome }}` or a custom value like `needs_human`. See [docs/status-values.md](docs/status-values.md). |
304-
| `agent_output` | | `''` | Raw stdout from the agent step. Used to auto-extract token counts from JSON. |
305-
| `input_tokens` | | `''` | Explicit input token count. Overrides extraction from `agent_output`. |
306-
| `output_tokens` | | `''` | Explicit output token count. |
307-
| `cache_read_tokens` | | `''` | Cache read token count. |
308-
| `cache_write_tokens` | | `''` | Cache write token count. |
309-
| `turns` | | `''` | Number of agent turns/iterations. |
310-
| `pr_number` | | `''` | PR number created by this run (if any). |
311-
| `workflow_run_id` | | `''` | Run ID of the triggering agent workflow (`github.event.workflow_run.id`). Enables auto-resolution of tokens, trigger number, timestamps, and gate logic. |
312-
| `started_at` | | `''` | ISO 8601 start timestamp. Overrides self-measured time. |
313-
| `completed_at` | | `''` | ISO 8601 completion timestamp. |
314-
| `trigger_number` | | `''` | Issue or PR number to comment on. Override when auto-resolution fails. |
315-
| `trigger_event` | | `''` | Original event name (`issues`, `pull_request`, etc.). Used with `trigger_number`. |
316-
| `post_comment` | | `true` | Set to `false` to skip posting a cost comment. |
317-
| `api_url` | | `https://agentmeter.app` | AgentMeter API base URL. Override for local dev or self-hosted. |
318-
| `github_token` | | `${{ github.token }}` | GitHub token for comment posting and artifact access. No config needed. |
300+
| `api_key` | yes | — | Your AgentMeter API key (`am_sk_…`). Get it from [agentmeter.app/dashboard/settings](https://agentmeter.app/dashboard/settings). |
301+
| `model` | no | `''` | The AI model used (e.g. `claude-sonnet-4-5`). Used for per-token cost display. |
302+
| `engine` | no | `claude` | The AI engine (`claude`, `codex`). |
303+
| `status` | no | `success` | Run outcome. In companion `workflow_run` mode this is resolved automatically from the triggering workflow's conclusion. In inline mode pass `${{ steps.agent.outcome }}` or a custom value like `needs_human`. See [docs/status-values.md](docs/status-values.md). |
304+
| `agent_output` | no | `''` | Raw stdout from the agent step. Used to auto-extract token counts from JSON. |
305+
| `input_tokens` | no | `''` | Explicit input token count. Overrides extraction from `agent_output`. |
306+
| `output_tokens` | no | `''` | Explicit output token count. |
307+
| `cache_read_tokens` | no | `''` | Cache read token count. |
308+
| `cache_write_tokens` | no | `''` | Cache write token count. |
309+
| `turns` | no | `''` | Number of agent turns/iterations. |
310+
| `pr_number` | no | `''` | PR number created by this run (if any). |
311+
| `workflow_run_id` | no | `''` | Run ID of the triggering agent workflow (`github.event.workflow_run.id`). Enables auto-resolution of tokens, trigger number, timestamps, and gate logic. |
312+
| `started_at` | no | `''` | ISO 8601 start timestamp. Overrides self-measured time. |
313+
| `completed_at` | no | `''` | ISO 8601 completion timestamp. |
314+
| `trigger_number` | no | `''` | Issue or PR number to comment on. Override when auto-resolution fails. |
315+
| `trigger_event` | no | `''` | Original event name (`issues`, `pull_request`, etc.). Used with `trigger_number`. |
316+
| `post_comment` | no | `true` | Set to `false` to skip posting a cost comment. |
317+
| `api_url` | no | `https://agentmeter.app` | AgentMeter API base URL. Override for local dev or self-hosted. |
318+
| `github_token` | no | `${{ github.token }}` | GitHub token for comment posting and artifact access. No config needed. |
319319

320320
---
321321

@@ -334,13 +334,13 @@ Replace `$INPUT_TOKENS` etc. with however your agent exposes token counts (step
334334
When the action runs in the context of a PR or issue, it posts (or updates) a cost summary comment:
335335

336336
```
337-
AgentMeter
337+
AgentMeter
338338
339339
| # | Workflow | Model | Status | Cost | Duration |
340340
|---|----------|-------|--------|------|----------|
341-
| 1 | Agent: Code Review | claude-sonnet-4-5 | success | $0.44 | 5m |
341+
| 1 | Agent: Code Review | claude-sonnet-4-5 | | $0.44 | 5m |
342342
343-
Token breakdown
343+
Token breakdown
344344
345345
| Type | Tokens | Cost |
346346
|------|--------|------|

0 commit comments

Comments
 (0)