Skip to main content

Sandgarden CLI Quickstart

note

Each initial command will be linked to its corresponding page once we're confident the CLI command tree is stable.

The Sandgarden CLI manages all aspects of workflow creation, testing, and runs, organized in a tree structure. Here's an overview of all of the available CLI commands.

batches​

The commands in this tree manage batch testing. For more information, check out Lifecycle of a test suite.

  • compare
  • get
  • list
  • start

connectors​

These commands are for setting up connectors, which are connections to external systems such as LLMs, databases, and other third-party tools.

  • create
    • custom
    • openai
    • postgres
  • delete
  • get
  • list
  • update
    • custom
    • openai
    • postgres
  • upsert
    • custom
    • openapi
    • postgres
tip

Update is used to update an existing connector. Upsert will create a connector, if none exists, or else update one that already exists.

runs​

These commands manage runs, which are discrete executions of a step or workflow (see below).

  • get
  • list
  • start

update​

This command updates the Sandgarden CLI to the latest version.

version​

This command returns the current version of the Sandgarden CLI.

steps​

  • check
  • delete-tag
  • delete
  • get
  • list
  • push
    • awsLambda
    • docker
  • tag

test-suites​

  • create
  • delete
  • get
  • list
  • start
  • update

workflows​

These commands are for managing Sandgarden workflows.

  • check
  • delete-tag
  • get
  • list
  • push
    • awsLambda
    • composite
    • docker
  • tag