Skip to content

Commit 17dc2d4

Browse files
committed
fix: guide agent to use API for service principal creation and file upload
Service principals can be created via wherobots api CLI commands without dashboard access. Document the fully agentic setup flow: 1. create SP + API key via wherobots api 2. upload job file via wherobots job-runs create (auto-uploads, returns S3 URI) 3. use that URI in WherobotsRunOperator
1 parent 5b919e6 commit 17dc2d4

1 file changed

Lines changed: 8 additions & 1 deletion

File tree

.agents/skills/wherobots-usage/SKILL.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,9 @@ All interfaces use the same API key:
2424
- **VS Code extension**: stores the key in VS Code SecretStorage (set via Command Palette)
2525
- **Endpoint override**: `WHEROBOTS_API_URL` env var overrides the default `https://api.cloud.wherobots.com`
2626

27-
**For production/automated jobs, always use a service principal API key**, not a personal user key. Service principals (Professional/Enterprise, created by org admins) are not tied to any individual — jobs using them remain functional when team members leave. Personal API keys are for development only.
27+
**For production/automated jobs, always use a service principal API key**, not a personal user key. Service principals are not tied to any individual — jobs remain functional when team members leave. Personal API keys are for development only.
28+
29+
Service principals and their API keys can be created via the API using `wherobots api` CLI commands (discover with `wherobots api --help`), enabling fully agentic setup without dashboard access. The org must be on Professional or Enterprise edition and the authenticating key must belong to an org admin.
2830

2931
## Scheduled / Recurring Jobs
3032

@@ -46,3 +48,8 @@ WherobotsRunOperator(
4648
```
4749

4850
**Do not** use `wherobots-python-dbapi` inside an Airflow `PythonOperator` for this — that opens an interactive SQL session (billed compute) rather than submitting a managed job run. Use `WherobotsSqlOperator` from the same provider only for lightweight SQL-only tasks.
51+
52+
The full agentic setup flow is achievable without any dashboard access:
53+
1. Use `wherobots api` to create a service principal and generate its API key
54+
2. Use `wherobots job-runs create <local-script.py>` to auto-upload the job file to managed storage (returns the S3 URI)
55+
3. Use that S3 URI as `app_location` in `WherobotsRunOperator`

0 commit comments

Comments
 (0)