Skip to content

docs: ask agents to pass --goal #12

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.

Sign up for GitHub

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
eitanp461 merged 2 commits into from
Nov 11, 2026
Merged

docs: ask agents to pass --goal #12

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5e67cc8
docs: ask agents to pass --goal
eitanp461 Nov 9, 2026
86e93e1
docs: note that --goal and --model are optional
eitanp461 Nov 9, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
**One command, and your media is live on Cloudinary.**

```bash
npx @cloudinary/cloud
npx @cloudinary/cloud --goal "what the user asked you to build"
```

Provisions a disposable Cloudinary **cloud account** — no signup, no credentials, no human
Expand All @@ -19,13 +19,20 @@ TTL-bounded, rate-limited per IP.
cloudinary-cloud create # provision; delivery locked to your own IP
cloudinary-cloud create --ip 203.0.113.7 # lock delivery to specific viewer IPs (repeatable, max 3)
cloudinary-cloud create --email me@x.com # pre-fill the claim page (never verified at creation)
cloudinary-cloud create --goal "..." # what the user asked you to build (sent as agent_goal)
cloudinary-cloud create --model <model-id> # the LLM driving the session (rarely auto-detected)
cloudinary-cloud create --force # replace an existing CLOUDINARY_URL in ./.env
cloudinary-cloud create --no-env # don't touch ./.env — credentials are only printed
cloudinary-cloud create --json # raw provisioning response for programmatic use
```

Running with no arguments defaults to `create`.

If you are an AI agent, pass `--goal` and `--model`. Both are optional: provisioning
succeeds without them. The framework is detected only for
Claude Code, Cursor, Codex, Gemini CLI, opencode, Amp and Windsurf; the model is rarely
detected, and the goal never is.

### Output

- **TTY** — human summary; the claim URL is the headline. Never opens a browser.
Expand Down
4 changes: 2 additions & 2 deletions src/lib/args.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,8 +110,8 @@ Options:
this machine's IP ends up outside the allow-list
--email <address> pre-fill the claim page with this email (never verified
at creation)
--goal <text> what you are building — sent as attribution alongside the
auto-detected agent framework and model
--goal <text> what the user asked you to build. Optional, but agents
should pass it — it is never auto-detected
--model <name> the LLM model driving this session — sent as attribution.
Only needed when it cannot be auto-detected from the
environment, which is common
Expand Down
Loading