Purpose
Provide a stable workflow for using fpt-cli from OpenClaw.
Keep the agent behavior aligned with the repository contract:
- prefer explicit CLI commands over ad-hoc API calls
- prefer JSON output for machine consumption
- prefer capability discovery before composing new command invocations
- prefer safe write previews before real mutations
When to use
Use this skill when any of the following is needed:
- install or update
fpt-cli - configure ShotGrid / FPT authentication for OpenClaw
- inspect which commands the CLI already exposes
- query schema or entities through the CLI
- run complex searches with
filter_dsl, structuredsearch, oradditional_filter_presets - perform write operations with
--dry-runfirst
Workflow
1. Choose the execution mode
Determine whether the task should use a released binary or a source checkout.
- For released binary installation or update, read
references/install-and-auth.mdand prefer release archives plus checksum verification over pipe-to-shell installers. - For repository-local development, prefer
vx cargo run -p fpt-cli -- ...andvx just ....
2. Prefer environment-based authentication
Load credentials through environment variables instead of putting secrets directly on the command line.
Preferred variables:
| Variable | Required | Auth modes | Description |
|---|---|---|---|
| FPT_SITE | required | all | Full URL of the ShotGrid / FPT site, e.g. https://example.shotgrid.autodesk.com |
| FPT_AUTH_MODE | required | all | Auth strategy: script, user_password, or session_token |
| FPT_SCRIPT_NAME | required | script | Name of the API script credential registered in ShotGrid |
| FPT_SCRIPT_KEY | required | script | Secret key for the script credential; quote the value when it contains special characters |
| FPT_USERNAME | required | user_password | ShotGrid user login (usually an email address) |
| FPT_PASSWORD | required | user_password | Password for the ShotGrid user account |
| FPT_AUTH_TOKEN | optional | user_password | One-time 2FA token; only needed when the site enforces two-factor authentication |
| FPT_SESSION_TOKEN | required | session_token | A pre-obtained ShotGrid session token; use when script or password credentials are unavailable |
| FPT_API_VERSION | optional | all | Override the ShotGrid REST API version, e.g. v1.1; defaults to the CLI built-in value when omitted |
Allow SG_* variables only as compatibility fallback when FPT_* is not available.
3. Discover the contract before composing commands
Inspect the CLI surface before building new automation.
Use:
fpt capabilities --output jsonfpt inspect command <command-name> --output json
Prefer dotted command names in inspection calls, for example:
entity.findentity.find-oneentity.update
4. Choose the narrowest useful command
Prefer the smallest command that satisfies the task.
- Use
entity.getwhen the entity id is known. - Use
entity.find-onewhen only one match is needed. - Use
entity.findwhen multiple matches or collection metadata are needed. - Use
entity.batch.*when repeating the same operation over many inputs. - Use
schema.entitiesandschema.fieldsbefore guessing entity or field names.
5. Prefer structured JSON output
Default to --output json unless a human explicitly needs a different view.
This keeps OpenClaw orchestration stable and lowers prompt/token overhead.
6. Prefer native search features for complex queries
For non-trivial filters:
- prefer structured
searchJSON when building native_searchpayloads - use
additional_filter_presetsfor “latest”-style workflows - use
--filter-dslfor concise human-authored boolean logic
Read references/query-patterns.md for examples.
7. Apply write safety rules
For writes:
- run
--dry-runfirst when supported - treat dry-run output as the request-plan contract
- require explicit confirmation before real deletes (
--yes)
8. Debug in a contract-first order
When something fails:
- validate auth with
auth test - inspect the command contract
- confirm entity and field names via schema commands
- reduce the command to the smallest JSON-shaped reproduction
- only then expand to batch or write workflows
References
references/install-and-auth.mdreferences/query-patterns.md
Scan to join WeChat group