cli-api

name	cli-api
description	CLI tool (csdk) for the api API — provides CRUD commands for 47 tables and 9 custom operations

cli-api

CLI tool (csdk) for the api API — provides CRUD commands for 47 tables and 9 custom operations

Usage

# Context management
csdk context create <name> --endpoint <url>
csdk context use <name>

# Authentication
csdk auth set-token <token>

# Config variables
csdk config set <key> <value>
csdk config get <key>

# CRUD for any table (e.g. api)
csdk api list
csdk api get --id <value>
csdk api create --<field> <value>

# Non-interactive mode (skip all prompts, use flags only)
csdk --no-tty api list

Examples

Set up and query

csdk context create local --endpoint http://localhost:5000/graphql
csdk context use local
csdk auth set-token <token>
csdk api list

Non-interactive mode (for scripts and CI)

csdk --no-tty api create --<field> <value>

References

See the references/ directory for detailed per-entity API documentation:

• context
• auth
• config
• api
• api-module
• api-schema
• api-setting
• app
• ast-migration
• check-constraint
• composite-type
• cors-setting
• database
• database-setting
• database-transfer
• default-privilege
• domain
• embedding-chunk
• enum
• field
• foreign-key-constraint
• full-text-search
• function
• http-route
• index
• managed-domain
• node-type-registry
• partition
• policy
• primary-key-constraint
• pubkey-setting
• rls-setting
• schema
• schema-grant
• site
• site-metadatum
• site-module
• site-theme
• spatial-relation
• sql-action
• table
• table-grant
• trigger
• trigger-function
• unique-constraint
• view
• view-grant
• view-rule
• view-table
• webauthn-setting
• apply-registry-defaults
• resolve-http-route
• accept-database-transfer
• apply-rls
• cancel-database-transfer
• provision-bucket
• reject-database-transfer
• request-database
• set-field-order