Octri

README and samples

Every SDK ships with a README and usage samples written for that language. They are generated from your spec, so they use your real method names and types, and stay correct as your API changes.

Choosing the quickstart

The first example most developers copy is the one at the top of your README. Choose it yourself.

  1. Open the endpoint in SDK Studio

    Pick the call you'd show someone first. For an email API, that's sending an email, not listing domains.

  2. Turn on Quickstart

    The Quickstart switch sits beside Deprecated on the endpoint's row.

  3. Publish

    The endpoint becomes the README's headline example in every language, whenever the generator can render the call.

Changing the quickstart rebuilds every language.

Quickstarton or off, per endpointdefault: off

Marks this endpoint as the README's headline example. With none marked, the generator picks one. octri sdk quickstart lists the endpoints marked.

quickstart on the endpoint · CLI octri sdk quickstart set

Your own README

To ship a README you wrote instead of the generated one, paste it into README in SDK Studio's package settings.

READMEMarkdowndefault: generated

Replaces the generated README in every language's package. Leave it empty to keep the generated one. With a GitHub repository linked, Pull from repo copies the repository's README.md in, and Push sends yours back.

readme

Usage samples

Each endpoint's sample is written in the language's own style and is checked against the generated code. The same samples appear in your docs' code panels when you generate a matching SDK.

Usage example controls how long they are: full or concise. See output detail.

Install instructions

The README's install line reflects where the language is really available. A language published to a registry shows the package manager command, so npm install appears only for a package that's on npm. See publishing.

Don't edit the generated README

Generated files are replaced on every build, so an edit made in the package is lost. To change what the README says, change the spec or the Studio setting behind it, or write your own.

From the CLI

octri sdk quickstart shows the headline endpoint, and octri sdk quickstart set <endpoint> chooses it.