The studio

The studio is where you change a CLI after it's built. It has four parts:

• A project chat. Its agent has the CLI's repository. Ask for a rename, hidden or regrouped commands, better help, or something bigger.
• Config, the CLI's okibi.yml, which you can edit and build.
• Improvements, the changes agent ready optimization suggests.
• Custom requests, for changes okibi.yml can't make, such as a new command or a missing endpoint.

Every change goes into a build, and your users get it only when you publish that build.

Owners, admins, and builders can use the studio. It opens once a build has saved the CLI's code. A CLI an older generator built has its generation chat instead; migrate it to get the studio.

Open it

Chat with the agent

Tell the agent what to change. It edits okibi.yml, and its change saves and builds after each of its turns. For a change okibi.yml can't make, it writes a custom request, which sends itself.

Your open chat is reused, so a chat you start in the terminal carries on in the app, and the other way around.

Edit okibi.yml

okibi.yml sits at the root of the CLI's repository and defines its commands. Accepted suggestions live in its sections. Your own changes go in its human section, and always win.

sections:
  human:
    entries:
      - target: {operation: "GET /invoices"}
        group: billing
        name: ls
      - target: {operation: "DELETE /customers/{id}"}
        enabled: false

• Each command is keyed by its method and path, as in the spec.
• Rename, group, alias, hide, or add examples to a command. Set enabled: false to leave it out.
• Editing an accepted suggestion's entry makes it yours: Okibi keeps it and never rewrites it.

If okibi.yml changed in the repository since you opened it, the app asks you to Keep mine or Load the new one. Keeping yours overwrites the change.

Review improvements

After a build, agent ready optimization works on Login, Command names, Help and examples, and Workflow commands. Workflow commands waits for a research step, How people use this API, which makes no suggestions of its own. Each change it finds is a suggestion: an okibi.yml diff with a title and why. Nothing changes until you accept it.

• An accepted suggestion builds at once. While a build runs, or a Regenerate waits for Publish, the next build carries it.
• You can take back an accept until a build carries it. After that, or once it shipped, it can't be rejected.
• A rejected suggestion isn't offered again.

Improvements run once the CLI is built, and Okibi emails you when they're ready to review. To stop them while they run, click Cancel improvements, or run okibi runs cancel-improvements <run-id>. Nothing they found is kept, and the build stays as it is.

Make a custom request

A custom request is a change okibi.yml can't make, such as a new command, a fix, or a missing endpoint. Okibi makes it in the chat's sandbox, asks you a question, or says why it can't. A done request's change goes into the next build. One request runs at a time, and none can start while improvements run.

Publish what you changed

Every studio change ships in a build that waits for Publish. The studio says "Build #12 is ready. Publish it". Nothing reaches your users until you do.

A newer build replaces one that is still waiting. See Builds.