Octri

sdk quickstart

Each SDK's README opens with one example call. On its own, this command shows which endpoint that is. With none chosen, the generator picks one. See README and samples.

Setting or clearing it publishes your SDK settings, as sdk settings set does, and applies to the next build.

bash
octri sdk quickstart [list | set <endpoint> | unset <endpoint>]

octri sdk quickstart set <endpoint>

Makes one endpoint the README's headline example.

Arguments

<endpoint>stringrequired

The endpoint, as its slug, its operation ID, or its method and path, such as GET /customers.

Flags

--changelog <text>string

A note for the settings history.

octri sdk quickstart unset <endpoint>

Clears it, so the generator picks again.

Arguments

<endpoint>stringrequired

The endpoint, written the same ways.

Examples

Lead with listing customers

bash
octri sdk quickstart set GET /customers
Output
✔ Publishing SDK settings
✔ get-customers is the README quickstart.