shellTerminals

Open a standalone shell terminal

Changed on
post/api/v1/shell-terminals

Request

  • Base URL
    http://127.0.0.1:3001
  • URL
    http://127.0.0.1:3001/api/v1/shell-terminals
  • Auth
    none declared

Request body

projectIdstring

Project whose root the shell starts in. Omitted opens the shell in the daemon data dir.

sessionIdstring

Agent session the shell is scoped to, so it appears only in that session's tab strip. Omitted makes it a standalone shell.

shellstring

Windows shell selector: auto, git-bash, pwsh, powershell, cmd, or a custom executable path. Ignored on macOS and Linux.

startOnAttachboolean

Start the shell when the requesting client attaches with its terminal grid instead of immediately, so the shell starts at the size that client shows. Only for clients that attach as a sized viewer; omitted starts the shell immediately at the default grid.

titlestring

Tab title for the new shell, for a client that already shows its tab. Trimmed; omitted or empty numbers it after the existing shells (Terminal N).

Response

Created

Changes

  • 8f160e6183cdRevision changes
    • info

      removed the agent_switch_saga enum value from the response property for the response status

    • info

      removed the agent_switch_saga enum value from the response property for the response status

    • info

      removed the agent_switch_saga enum value from the response property for the response status

    • info

      removed the agent_switch_saga enum value from the response property for the response status

  • 3e5461a4c02aRevision changes
    • info

      added the new optional request property

    • info

      added the new optional request property