Skip to content

Commit 841d6f2

Browse files
committed
docs(readme): update input descriptions and clarify cursor-version usage in README
1 parent abb404c commit 841d6f2

1 file changed

Lines changed: 26 additions & 17 deletions

File tree

README.md

Lines changed: 26 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -25,23 +25,23 @@
2525
2626
## Inputs
2727
28-
| Input | Required | Default | Description |
29-
| ------------------- | -------- | ------------------- | --------------------------------------------------------------------- |
30-
| `api-key` | ✅ | — | Your Cursor API key. Store as a secret. |
31-
| `prompt` | ✅ | — | The prompt to pass to `cursor-agent`. |
32-
| `cursor-version` | ❌ | `latest` | Cursor CLI version to install. Use `latest` or a semver like `1.2.3`. |
33-
| `model` | ❌ | `claude-sonnet-4-5` | Model for the agent to use. |
34-
| `working-directory` | ❌ | `.` | Directory the agent operates in. |
35-
| `permissions` | ❌ | `read-only` | Agent permissions: `read-only`, `read-write`, or `full`. |
36-
| `timeout` | ❌ | `300` | Timeout in seconds before the agent is killed. |
28+
| Input | Required | Default | Description |
29+
| ------------------- | -------- | ------------------- | ---------------------------------------------------------------------------------------------------- |
30+
| `api-key` | ✅ | — | Your Cursor API key. Store as a secret. |
31+
| `prompt` | ✅ | — | The prompt to pass to `cursor-agent`. |
32+
| `cursor-version` | ❌ | `latest` | Cursor CLI build to install. Use `latest` or an exact Cursor lab build id like `2026.03.20-44cb435`. |
33+
| `model` | ❌ | `claude-sonnet-4-5` | Model for the agent to use. |
34+
| `working-directory` | ❌ | `.` | Directory the agent operates in. |
35+
| `permissions` | ❌ | `read-only` | Agent permissions: `read-only`, `read-write`, or `full`. |
36+
| `timeout` | ❌ | `300` | Timeout in seconds before the agent is killed. |
3737

3838
## Outputs
3939

40-
| Output | Description |
41-
| ----------- | --------------------------------------------------- |
42-
| `summary` | Text response from the agent. |
43-
| `exit-code` | Raw exit code from the `cursor-agent` process. |
44-
| `cache-hit` | `"true"` if the CLI binary was restored from cache. |
40+
| Output | Description |
41+
| ----------- | ----------------------------------------------------------- |
42+
| `summary` | Text response from the agent. |
43+
| `exit-code` | Raw exit code from the `cursor-agent` process. |
44+
| `cache-hit` | `"true"` if the Cursor CLI install was restored from cache. |
4545

4646
---
4747

@@ -91,7 +91,7 @@ jobs:
9191
with:
9292
api-key: ${{ secrets.CURSOR_API_KEY }}
9393
prompt: "Generate a changelog entry for the latest commit."
94-
cursor-version: "1.2.3"
94+
cursor-version: "2026.03.20-44cb435"
9595
```
9696
9797
### Read-write permissions (agent can modify files)
@@ -107,12 +107,21 @@ jobs:
107107
108108
---
109109
110+
## Version Resolution
111+
112+
`cursor-version: latest` resolves to the current published Cursor lab build before download. The action first checks Cursor's lab `latest-version` endpoint and, if that endpoint is unavailable or returns an access error, falls back to parsing the official [`https://cursor.com/install`](https://cursor.com/install) installer script.
113+
114+
If you want reproducible installs, pin `cursor-version` to an exact lab build id such as `2026.03.20-44cb435`. Values like `1.2.3` are not published Cursor lab artifact versions and will fail to download.
115+
116+
---
117+
110118
## Caching
111119

112-
The action caches the Cursor CLI binary across jobs using `@actions/cache`. The cache key includes the platform, architecture, and resolved version, so:
120+
The action caches the extracted Cursor CLI package across jobs using `@actions/cache`. The cache key includes the platform, architecture, and resolved version, so:
113121

114122
- `latest` resolves to a concrete version before caching — it won't re-download on every run once cached.
115-
- Pinning a version (e.g. `1.2.3`) gives you a stable, reproducible cache hit every time.
123+
- Pinning a version (e.g. `2026.03.20-44cb435`) gives you a stable, reproducible cache hit every time.
124+
- The full installed package is cached, not just the `cursor-agent` launcher.
116125

117126
---
118127

0 commit comments

Comments
 (0)