### Node.js Setup Example Source: https://docs.superset.sh/setup-teardown-scripts Example of setup commands for a Node.js project, including dependency installation and environment file copying. ```json { "setup": ["bun install", "cp \"$SUPERSET_ROOT_PATH/.env\" .env"] } ``` -------------------------------- ### Example Setup Script for Port Allocation Source: https://docs.superset.sh/llms-full.txt This shell script demonstrates how to implement deterministic per-workspace port ranges by reserving a range in a shared file during setup. ```shell #!/bin/bash # Example: Reserve ports 5000-5999 for this workspace PORT_RANGE_START=5000 PORT_RANGE_END=5999 # Ensure the allocation file exists ALLOCATION_FILE="~/.superset/port-allocations.json" if [ ! -f "$ALLOCATION_FILE" ]; then echo "{\"allocations\": {}}" > "$ALLOCATION_FILE" fi # Add this workspace's allocation (simplified example) # In a real scenario, you'd need more robust locking and allocation logic # to prevent conflicts between concurrent workspace setups. WORKSPACE_ID=$(basename "$(pwd)") jq --argjson start "$PORT_RANGE_START" --argjson end "$PORT_RANGE_END" --arg id "$WORKSPACE_ID" '.allocations[$id] = {"start": $start, "end": $end}' "$ALLOCATION_FILE" > tmp.$$ cat tmp.$$ > "$ALLOCATION_FILE" rm tmp.$$ echo "Ports $PORT_RANGE_START-$PORT_RANGE_END reserved for workspace $WORKSPACE_ID." ``` -------------------------------- ### Configure .superset/config.json for Setup Scripts Source: https://docs.superset.sh/setup-teardown-scripts Create a .superset/config.json file in your project root to define setup scripts. This example shows how to configure a 'setup' script using 'bun install'. ```json { "setup": "bun install", "teardown": "bun uninstall" } ``` -------------------------------- ### Start Superset Host Server (CLI) Source: https://docs.superset.sh/llms-full.txt Use this command to start the Superset host server in the background and register the machine with the relay. Ensure you have completed the CLI setup and host server documentation. ```bash superset auth login superset start --daemon ``` -------------------------------- ### Bun Script for Extra Setup Step Source: https://docs.superset.sh/setup-teardown-scripts This snippet shows how to define an extra setup step using Bun. It specifies the command to run for the setup. ```json ["$","span",null,{"style":{"--shiki-light":"#005CC5","--shiki-dark":"#79B8FF"},"children":"\"after\""},{"$","span",null,{"style":{"--shiki-light":"#24292E","--shiki-dark":"#E1E4E8"},"children":": ["},{"$","span",null,{"style":{"--shiki-light":"#032F62","--shiki-dark":"#9ECBFF"},"children":"\"bun run my-extra-step\""},{"$","span",null,{"style":{"--shiki-light":"#24292E","--shiki-dark":"#E1E4E8"},"children":" ] "}}] ``` -------------------------------- ### Install Dependencies Source: https://docs.superset.sh/first-workspace Use this command to install project dependencies. Ensure you have Bun installed. ```bash bun install ``` -------------------------------- ### Skip Setup Entirely Source: https://docs.superset.sh/setup-teardown-scripts Configuration to disable both setup and teardown scripts. ```json { "setup": [], "teardown": [] } ``` -------------------------------- ### Install Node.js Dependencies and Copy Environment File Source: https://docs.superset.sh/setup-teardown-scripts Use this command to install Node.js dependencies and copy the environment file for Superset setup. Ensure you have Bun installed and the SUPERSET_ROOT_PATH variable correctly set. ```bash { "setup": ["bun install", "cp $SUPERSET_ROOT_PATH/.env .env"] } ``` -------------------------------- ### Install and Run Superset Scripts Source: https://docs.superset.sh/setup-teardown-scripts Use these commands to install Superset dependencies and execute the run script. Ensure you have npm installed. ```bash { "setup": [ "npm install" ], "run": [ "./.superset/run.sh" ] } ``` -------------------------------- ### Local Config: Extending Setup with 'before' and 'after' Source: https://docs.superset.sh/llms-full.txt Extends the committed setup scripts by adding commands to run before and after the main setup. Teardown is extended with an 'after' script. ```json { "setup": { "before": ["echo 'running pre-setup'"], "after": ["./.superset/my-post-setup.sh"] }, "teardown": { "after": ["./.superset/my-cleanup.sh"] } } ``` -------------------------------- ### Define Custom Setup Script Source: https://docs.superset.sh/setup-teardown-scripts Use this configuration to specify a custom setup script that will be executed. This replaces any default setup scripts. ```yaml SETUP_SCRIPT_FILES = [ "./.superset/my-custom-setup.sh" ] ``` -------------------------------- ### Monorepo Setup Script Source: https://docs.superset.sh/llms-full.txt Use this JSON configuration in your setup script to install dependencies and copy environment files. ```json { "setup": [ "bun install", "cp \"$SUPERSET_ROOT_PATH/.env\" .env" ] } ``` -------------------------------- ### Execute Setup and Teardown Scripts Source: https://docs.superset.sh/setup-teardown-scripts These commands execute the project's setup and teardown scripts. Ensure the paths to these scripts are correct. ```bash run \"./.superset/teardown.sh\" run \"./.superset/run.sh\" ``` -------------------------------- ### Example Theme Configuration Source: https://docs.superset.sh/custom-themes An example of a theme configuration object, showing how to define primary and secondary colors, as well as font families. ```javascript const theme = { primary: "#00b7ff", secondary: "#ff5ecf", fontFamily: "Arial, sans-serif" }; ``` -------------------------------- ### Setup Project on Local Machine Source: https://docs.superset.sh/cli/getting-started Attach to an existing project in your organization that is not yet on your local machine. This avoids creating duplicates. ```bash superset projects setup --local --parent-dir ~/code ``` -------------------------------- ### Docker Setup Command for Superset Source: https://docs.superset.sh/setup-teardown-scripts This command is used for setting up Apache Superset within a Docker environment. It outlines the necessary steps for a Docker-based installation. ```bash { "setup": ["docker compose pull", "docker compose up -d"] } ``` -------------------------------- ### Example Prompt for Theme Customization Source: https://docs.superset.sh/custom-themes This is an example of a prompt you can use to ask an agent to customize a Superset theme. It specifies the file to use and the desired changes. ```bash Can you customize the theme file `my_theme.json` to use the color palette from the `coolors.co` website? ``` -------------------------------- ### Install Superset SDK with bun Source: https://docs.superset.sh/llms-full.txt Install the Superset SDK using bun. Active development means new methods are added frequently; use the latest version. ```bash bun add @superset_sh/sdk ``` -------------------------------- ### Local Config: Override Entirely Source: https://docs.superset.sh/setup-teardown-scripts Completely replaces the default setup scripts with a custom list of commands. ```json { "setup": ["./.superset/my-custom-setup.sh"] } ``` -------------------------------- ### Setup Superset Project Source: https://docs.superset.sh/cli/host-server Use this command to attach to an existing Superset project. This is used on subsequent machines after the initial project creation. ```bash superset projects setup ``` -------------------------------- ### Install Superset SDK with pnpm Source: https://docs.superset.sh/llms-full.txt Install the Superset SDK using pnpm. It is recommended to stay on the latest version as the SDK is under active development. ```bash pnpm add @superset_sh/sdk ``` -------------------------------- ### Install OpenCode Agent CLI Source: https://docs.superset.sh/cli/host-server Instructions for installing the OpenCode agent CLI. Refer to the provided URL for detailed documentation. ```bash see opencode.ai/docs ``` -------------------------------- ### SDK Installation Source: https://docs.superset.sh/llms-full.txt Instructions for installing the Superset TypeScript SDK using various package managers. ```APIDOC ## Install ```bash npm install @superset_sh/sdk ``` ```bash pnpm add @superset_sh/sdk ``` ```bash yarn add @superset_sh/sdk ``` ```bash bun add @superset_sh/sdk ``` ``` -------------------------------- ### Standalone Install using curl Source: https://docs.superset.sh/cli/getting-started This command downloads and installs the Superset CLI using curl. Ensure you have curl installed and that your system's security policies allow script execution from the downloaded source. ```shell curl -fsSL https://raw.githubusercontent.com/apache/superset/master/install-superset-cli.sh | bash ``` -------------------------------- ### Define Setup and Teardown Scripts Source: https://docs.superset.sh/setup-teardown-scripts Configure 'setup' and 'teardown' scripts to run custom commands during Superset's lifecycle. The 'before' scripts execute prior to setup, and 'after' scripts run post-setup. Teardown scripts are for cleanup operations. ```javascript { "setup": { "before": [ "echo 'running pre-setup'" ], "after": [ "./.superset/my-post-setup.sh" ] }, "teardown": { "after": [ "./.superset/my-cleanup.sh" ] } } ``` -------------------------------- ### Example Run Script Configuration Source: https://docs.superset.sh/setup-teardown-scripts This configuration defines a script to be executed when the 'Run' button is clicked. It specifies the command to run and its arguments. ```json { "run": [ { "label": "Run", "command": "./.superset/run.sh" } ] } ``` -------------------------------- ### Configure Workspace Scripts Source: https://docs.superset.sh/setup-teardown-scripts Define setup, teardown, and run commands in `.superset/config.json`. Setup and teardown commands run sequentially in the workspace directory. ```json { "setup": ["bun install", "cp \"$SUPERSET_ROOT_PATH/.env\" .env"], "teardown": ["docker-compose down"], "run": ["./.superset/run.sh"] } ``` -------------------------------- ### Install Superset CLI with Homebrew Source: https://docs.superset.sh/cli/getting-started Install the Superset CLI using Homebrew. This is the recommended method for macOS and Linux users. ```bash brew install superset-sh/tap/superset ``` -------------------------------- ### Install Superset SDK with yarn Source: https://docs.superset.sh/llms-full.txt Install the Superset SDK using yarn. The SDK follows the API as it grows, so staying on the latest version is advised. ```bash yarn add @superset_sh/sdk ``` -------------------------------- ### Setup Script Configuration in package.json Source: https://docs.superset.sh/setup-teardown-scripts Configure setup scripts in your package.json file. Use shell scripts for complex logic and ensure they are restartable. ```json { "setup": [ "./.superset/setup.sh" ] } ``` -------------------------------- ### Install Superset CLI Standalone Source: https://docs.superset.sh/cli/getting-started Use this script to automatically download and install the Superset CLI for your platform and add it to your PATH. ```bash curl -fsSL https://superset.sh/cli/install.sh | sh ``` -------------------------------- ### Install Superset SDK with npm Source: https://docs.superset.sh/llms-full.txt Install the Superset SDK using npm. Ensure you are using the latest version for the most up-to-date features and fixes. ```bash npm install @superset_sh/sdk ``` -------------------------------- ### Skip Superset Setup Entirely Source: https://docs.superset.sh/setup-teardown-scripts Option to completely bypass the setup process for Superset. This is useful in environments where setup scripts are not required or should be manually managed. ```json { "skip_setup": true } ``` -------------------------------- ### Start Superset Host Server Source: https://docs.superset.sh/cli/host-server Spawns the daemon in the background and writes a manifest at ~/.superset/host//manifest.json. It binds to 127.0.0.1 only. ```bash superset start --daemon ``` -------------------------------- ### Git Submodules Setup Script Source: https://docs.superset.sh/llms-full.txt Integrate git submodule updates into your setup script for recursive submodule initialization. ```json { "setup": ["git submodule update --init --recursive", "bun install"] } ``` -------------------------------- ### superset projects setup Source: https://docs.superset.sh/llms-full.txt Adopts an existing project onto a host without creating a duplicate cloud record. Useful for setting up a project on a new machine. ```APIDOC ## superset projects setup ### Description Adopt an existing project onto a host without creating a duplicate cloud record. This is the counterpart to `create` for the scenario where a machine is new, but the repository is already part of the organization. Find the project ID using `projects list`. This command is idempotent: re-running it against a project already set up at the same path will result in a no-op, returning the existing `mainWorkspaceId`. ### Method `superset projects setup ` ### Arguments * `id` (required): The UUID of the project to adopt. ### Options * `--host `: Target host machineId. Mutually exclusive with `--local`; one is required. * `--local`: Target this machine. Mutually exclusive with `--host`; one is required. * `--parent-dir `: The parent directory where the project's repository will be cloned. The repository URL is obtained from the cloud project, so `--clone ` is not needed. * `--import `: Path to an existing repository on the target host. * `--allow-relocate`: Allows re-importing at a different path if the project is already set up at the current location. Applicable only when using `--import`. ### Output Schema { repoPath: string; mainWorkspaceId: string | null; } ### Examples ```bash # Pick an ID from `superset projects list`, then clone it onto this machine superset projects setup 47c31b04-… --local --parent-dir ~/code # Or register an existing local checkout superset projects setup 47c31b04-… --local --import ~/code/my-app ``` ``` -------------------------------- ### Start Local Host Server Source: https://docs.superset.sh/llms-full.txt Starts the local host server (daemon) that the CLI and desktop app communicate with. If a manifest exists and the process is alive, it returns the existing instance's details. Otherwise, it spawns the host server binary, polls for health, and writes a manifest. It binds only to `127.0.0.1`. ```APIDOC ## superset start ### Description Start the local host server — the daemon the CLI and desktop app both talk to when targeting this machine. ### Options - `--daemon` (boolean) - Run detached. - `--port ` (number) - Specific port. Default: a free loopback port. ### Returns The running host server. ```json { "pid": number, "port": number, "organizationId": string } ``` ``` -------------------------------- ### Using config.local.json for Personal Steps Source: https://docs.superset.sh/setup-teardown-scripts Add personal setup steps without altering the team's shared configuration by using `config.local.json`. ```json config.local.json ``` -------------------------------- ### Local Config: Mix and Match Source: https://docs.superset.sh/setup-teardown-scripts Combines extending setup scripts with overriding teardown scripts. ```json { "setup": { "after": ["bun run my-extra-step"] }, "teardown": ["my-custom-teardown.sh"] } ``` -------------------------------- ### Configure Custom Setup and Teardown Scripts Source: https://docs.superset.sh/setup-teardown-scripts Define custom setup and teardown scripts for your Superset project. These scripts are executed during project setup and teardown processes. Specify the paths to your shell scripts within the Superset configuration. ```json { "setup": [ "~/.superset/projects//setup.sh" ], "teardown": [ "~/.superset/projects//teardown.sh" ] } ``` -------------------------------- ### Setup Superset Project on Subsequent Machines Source: https://docs.superset.sh/cli/host-server Adopts an existing Superset project on a new machine by cloning its repository. Use the project ID obtained from `projects list`. ```bash superset projects setup 47c31b04-… --local --parent-dir ~/code ``` -------------------------------- ### Docker Teardown Example Source: https://docs.superset.sh/setup-teardown-scripts Example of a teardown command for a Docker-based project, stopping Docker Compose services. ```json { "teardown": ["docker-compose down"] } ``` -------------------------------- ### Full Project Configuration Source: https://docs.superset.sh/setup-teardown-scripts A comprehensive configuration including setup, teardown, and run scripts for a Superset project. ```json { "setup": ["./.superset/setup.sh"], "teardown": ["./.superset/teardown.sh"], "run": ["./.superset/run.sh"] } ``` -------------------------------- ### Local Config: Prepend and Append Scripts Source: https://docs.superset.sh/setup-teardown-scripts Extends existing setup and teardown scripts by adding custom commands before or after the default scripts. ```json { "setup": { "before": ["echo 'running pre-setup'"] matters, "after": ["./.superset/my-post-setup.sh"] }, "teardown": { "after": ["./.superset/my-cleanup.sh"] } } ``` -------------------------------- ### Install Superset CLI using install.sh Source: https://docs.superset.sh/cli/getting-started This script automatically detects your platform (macOS Apple Silicon or Linux x86_64), installs Superset, and configures your shell's PATH. ```bash curl -fsSL https://superset.sh/install.sh | bash ``` -------------------------------- ### Default Project Scripts Source: https://docs.superset.sh/setup-teardown-scripts Default setup and teardown scripts for a Superset project. ```json { "setup": ["docker-compose up -d", "bun run db:migrate"], "teardown": ["docker-compose down -v"] } ``` -------------------------------- ### Setup a Superset Project Locally Source: https://docs.superset.sh/cli/cli-reference Use this command to adopt an existing project onto a host without creating a duplicate cloud record. It can be used to clone a project from the cloud or import an existing local checkout. Find the project ID using `superset projects list`. ```bash superset projects setup 47c31b04-… --local --parent-dir ~/code ``` ```bash superset projects setup 47c31b04-… --local --import ~/code/my-app ``` -------------------------------- ### Install Superset Version (JSON) Source: https://docs.superset.sh/cli/cli-reference Returns a JSON object indicating the result of a Superset installation or update, including current and target versions and whether an update occurred. ```json { current: string; target: string; updated: boolean; installRoot?: string; } ``` -------------------------------- ### Superset Setup and Teardown Script Configuration Source: https://docs.superset.sh/setup-teardown-scripts Defines the 'setup' and 'teardown' commands within a configuration, likely for a Docker Compose or similar orchestration tool. Use these to manage Superset's environment lifecycle. ```json { "setup": [ "docker-compose up -d" ], "teardown": [ "docker-compose down -v" ] } ``` -------------------------------- ### superset projects setup Source: https://docs.superset.sh/cli/cli-reference Adopts an existing project onto a host without creating a duplicate cloud record. This command is idempotent and can be used to register an existing local checkout or clone a project from the cloud. ```APIDOC ## superset projects setup ### Description Adopt an existing project onto a host without creating a duplicate cloud record. Counterpart to [`create`](#superset-projects-create) for the "new machine, repo already in the org" case. Find the project ID via [`projects list`](#superset-projects-list). Idempotent: re-running against a project that's already set up at the same path is a no-op that returns the existing `mainWorkspaceId`. ### Arguments #### `` - **Type**: required - **Description**: Project UUID to adopt. ### Options #### `--host ` - **Description**: Target host machineId. Mutually exclusive with `--local`; one is required. #### `--local` - **Description**: Target this machine. Mutually exclusive with `--host`; one is required. #### `--parent-dir ` - **Description**: Parent directory to clone the project's repo into (clone mode). The URL comes from the cloud project, so no `--clone ` is needed. #### `--import ` - **Description**: Existing repo path on the target host (import mode). #### `--allow-relocate` - **Description**: Permit re-importing at a different path if the project is already set up here. `--import` only. ### Example ```bash # Pick an ID from `superset projects list`, then clone it onto this machine superset projects setup 47c31b04-… --local --parent-dir ~/code # Or register an existing local checkout superset projects setup 47c31b04-… --local --import ~/code/my-app ``` ``` -------------------------------- ### Superset CLI: Human-readable Login Output Source: https://docs.superset.sh/llms-full.txt Example of the human-readable output after a successful Superset CLI login. ```text ◇ Authorized! │ Satya Patel (you@example.com) │ Organization: Acme └ Logged in successfully. ``` -------------------------------- ### Using 'run' for Dev Servers Source: https://docs.superset.sh/setup-teardown-scripts Utilize the 'run' command for development servers instead of placing them in the 'setup' scripts. This ensures scripts are restartable and do not block workspace creation. ```bash run ``` -------------------------------- ### Superset Setup and Teardown Script Execution Source: https://docs.superset.sh/setup-teardown-scripts Specifies the paths to the shell scripts for Superset's setup and teardown processes. These scripts are typically executed by an orchestration tool. ```json { "setup": [ "./.superset/setup.sh" ], "teardown": [ "./.superset/teardown.sh" ] } ``` -------------------------------- ### superset update Source: https://docs.superset.sh/cli/cli-reference Manages the update process for the Superset installation. It can download and replace the installation root with a new version from GitHub Releases. Available only in built binaries. ```APIDOC ## superset update ### Description Downloads the matching `superset-.tar.gz` from GitHub Releases and atomically replaces the install root. Only available in built binaries; running from `bun run dev` errors out. ### Usage ```bash superset update superset update --check superset update --version 0.1.2 ``` ### Options #### `--check` Only check for updates; don't install. Displays current and target versions. #### `--version ` Install a specific version (e.g. `0.1.2`) instead of the rolling latest. Accepts upgrade or downgrade. #### `--force` Re-install even if already on that version. ### Returns The current and target version, plus whether anything changed. Example (Success): ``` Updated 0.1.4 → 0.1.5 (/Users/you/.local/share/superset) ``` ### JSON Output (with `--json` flag) For `--check`: ```json { "current": "string", "target": "string", "upToDate": "boolean", "pinned": "boolean" } ``` For install: ```json { "current": "string", "target": "string", "updated": "boolean", "installRoot": "string" (optional) } ``` ``` -------------------------------- ### Basic Resource Management Source: https://docs.superset.sh/llms-full.txt Examples of common operations using the Superset SDK, including creating, updating, retrieving, and listing tasks, projects, hosts, and automations. ```APIDOC // Create a task const task = await client.tasks.create({ title: 'Wire up auth', priority: 'high', }); // Update it await client.tasks.update({ id: task.id, statusId: '' }); // Look one up by id or slug const got = await client.tasks.retrieve('SUPER-172'); // returns null if missing // Find tasks with rich filters const urgent = await client.tasks.list({ priority: 'urgent', search: 'auth', creatorMe: true, }); // Inspect what else you have const projects = await client.projects.list(); const hosts = await client.hosts.list(); const automations = await client.automations.list(); // Trigger an automation off-schedule await client.automations.run(''); // Create a workspace on a developer's machine await client.workspaces.create({ hostId: '', projectId: '', name: 'fix-auth-bug', branch: 'fix/auth', }); ``` -------------------------------- ### Setup Superset Project (Import Mode) Source: https://docs.superset.sh/llms-full.txt Adopts an existing project onto a host by registering a local checkout. Use this when the project and its repository already exist on the target machine. Requires the project ID and either a local target or a host ID. ```bash superset projects setup 47c31b04-… --local --import ~\/code\/my-app ``` -------------------------------- ### Client Initialization Source: https://docs.superset.sh/llms-full.txt Demonstrates how to create an instance of the Superset client, with options for environment variable configuration or explicit parameter passing. ```APIDOC ## Create the client ```ts import Superset from '@superset_sh/sdk'; const client = new Superset(); // reads SUPERSET_API_KEY and SUPERSET_ORGANIZATION_ID from env ``` ## Configuration You can configure the client explicitly instead of (or alongside) the env vars: ```ts const client = new Superset({ apiKey: 'sk_live_…', organizationId: '…', timeout: 60_000, // default: 60s per request maxRetries: 2, // default: 2 retries with exponential backoff logLevel: 'warn', // 'off' | 'error' | 'warn' | 'info' | 'debug' }); ``` ``` -------------------------------- ### Setup Superset Project (Clone Mode) Source: https://docs.superset.sh/llms-full.txt Adopts an existing project onto a host by cloning its repository. Use this when a project already exists in the organization but needs to be set up on a new machine. Requires the project ID and either a local target or a host ID. The parent directory is needed for cloning. ```bash superset projects setup 47c31b04-… --local --parent-dir ~\/code ``` -------------------------------- ### Prompting an Agent for Theme Customization Source: https://docs.superset.sh/custom-themes When customizing a downloaded base theme file, you can use an agent by providing a prompt with specific instructions. This example shows a basic prompt structure. ```text After downloading the base file, you can prompt an agent with something like: ``` -------------------------------- ### Authenticate Superset CLI Source: https://docs.superset.sh/cli/host-server Log in to your Superset session to authenticate the CLI. Refer to Getting Started for the full sign-in flow, including API-key authentication for CI. ```bash superset auth login ``` -------------------------------- ### Manually Configure Superset MCP Server Source: https://docs.superset.sh/llms-full.txt Configure the Superset MCP server by adding specific configuration files to your project or user settings. These examples show the file structure and content for different tools. ```json { "mcpServers": { "superset": { "type": "http", "url": "https://api.superset.sh/api/v2/agent/mcp" } } } ``` ```json { "mcpServers": { "superset": { "type": "http", "url": "https://api.superset.sh/api/v2/agent/mcp" } } } ``` ```json { "mcpServers": { "superset": { "url": "https://api.superset.sh/api/v2/agent/mcp" } } } ``` ```toml [mcp_servers.superset] url = "https://api.superset.sh/api/v2/agent/mcp" ``` ```json { "mcpServers": { "superset": { "httpUrl": "https://api.superset.sh/api/v2/agent/mcp" } } } ``` ```json { "$schema": "https://opencode.ai/config.json", "mcp": { "superset": { "type": "remote", "url": "https://api.superset.sh/api/v2/agent/mcp" } } } ``` ```json { "amp.mcpServers": { "superset": { "url": "https://api.superset.sh/api/v2/agent/mcp" } } } ``` -------------------------------- ### Create Superset Projects and Workspaces Source: https://docs.superset.sh/cli/getting-started Commands like 'projects create', 'projects setup', and 'workspaces create' require explicit '--host' or '--local' flags. The 'workspaces list' command defaults to organization-wide if neither flag is provided; use '--local' to restrict it to the current machine. ```bash projects create ``` ```bash projects setup ``` ```bash workspaces create ``` ```bash --host ``` ```bash --local ``` ```bash workspaces list ``` ```bash --host ``` ```bash --local ``` -------------------------------- ### Install Gemini CLI Agent Source: https://docs.superset.sh/cli/host-server Install the Gemini CLI agent using npm. This is one of the optional agent CLIs that can be installed. ```bash npm install -g @google/gemini-cli ``` -------------------------------- ### Install Amp Agent CLI Source: https://docs.superset.sh/cli/host-server Install the Amp agent CLI using npm. This is one of the optional agent CLIs that can be installed. ```bash npm install -g @sourcegraph/amp ``` -------------------------------- ### Install Codex Agent CLI Source: https://docs.superset.sh/cli/host-server Install the Codex agent CLI using npm. This is one of the optional agent CLIs that can be installed. ```bash npm install -g @openai/codex ``` -------------------------------- ### Install Claude Code Agent CLI Source: https://docs.superset.sh/cli/host-server Install the Claude Code agent CLI using npm. This is one of the optional agent CLIs that can be installed. ```bash npm install -g @anthropic-ai/claude-code ``` -------------------------------- ### Get Automation Metadata Source: https://docs.superset.sh/llms-full.txt Retrieves the metadata for a specific automation by its ID. To get the prompt body, use `automations prompt get`. For run history, use `automations logs`. ```bash superset automations get ``` -------------------------------- ### Create Superset Project (Import) Source: https://docs.superset.sh/llms-full.txt Creates a new project by importing an existing repository from a specified path on the target host. Requires a name and either a local target or a host ID. ```bash superset projects create --name "my-app" --local --import ~\/code\/my-app ``` -------------------------------- ### Automation Schedule Examples (RRules) Source: https://docs.superset.sh/llms-full.txt Examples of RFC 5545 RRules for scheduling automations. Use custom RRules for specific cadences. ```text FREQ=DAILY;BYHOUR=9;BYMINUTE=0 ``` ```text FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR;BYHOUR=9;BYMINUTE=0 ``` ```text FREQ=WEEKLY;BYDAY=FR;BYHOUR=17;BYMINUTE=0 ``` -------------------------------- ### Example Single Theme Object Source: https://docs.superset.sh/custom-themes This is an example of a single theme object that can be imported into Superset. It includes UI and terminal color overrides. ```json { "id": "my-custom-theme", "name": "My Custom Theme", "type": "dark", "ui": { "primary": "#FF0000", "secondary": "#00FF00" }, "terminal": { "background": "#111111", "foreground": "#EEEEEE" } } ``` -------------------------------- ### Create Project by Importing Existing Checkout Source: https://docs.superset.sh/cli/getting-started Register a new project by importing an existing local code checkout. Provide a name, local flag, and the path to the project. ```bash superset projects create --name "my-app" --local --import ~/code/my-app ``` -------------------------------- ### Superset CLI Output Formatting Flags Source: https://docs.superset.sh/cli/getting-started Use the --json flag to get the data payload as formatted JSON. Use the --quiet flag to get one ID per line for arrays of objects with 'id', the ID for single objects, or JSON otherwise. ```bash superset tasks list --status in_progress --json | jq '.["].title' ``` ```bash superset workspaces list --quiet | xargs -L1 superset workspaces delete ``` -------------------------------- ### List Superset Hosts and Workspaces Source: https://docs.superset.sh/cli/getting-started Use the 'superset hosts list' and 'superset workspaces list' commands to view available hosts and workspaces. The '--host' flag can be used to specify a particular host. ```bash superset hosts list superset workspaces list superset workspaces list --host h… ``` ```bash superset workspaces list --local ``` -------------------------------- ### superset tasks get Source: https://docs.superset.sh/llms-full.txt Retrieves a specific task by its ID or slug. ```APIDOC ## superset tasks get ### Description Get a task by ID or slug. ### Method CLI Command ### Endpoint N/A (CLI command) ### Parameters #### Arguments - **idOrSlug** (string) - Required - Task ID or slug. ### Request Example ```bash superset tasks get tsk_… superset tasks get fix-login-bug ``` ### Response #### Success Response Output is a Task object. #### Response Example (Task object) ``` -------------------------------- ### Create a Superset Project Source: https://docs.superset.sh/cli/host-server Use this command to create a new Superset project. This command should only be run on the first machine that registers a repository. ```bash superset projects create ``` -------------------------------- ### Create a Superset Project Source: https://docs.superset.sh/cli/host-server Use this command to create a new Superset project. It can clone a new repo or import an existing one. Ensure you provide a unique name for the project. ```bash superset projects create \"My Project\" --local \"~/code\" --import \"~/code/existing-repo\" ``` -------------------------------- ### Create Project by Cloning from Git Source: https://docs.superset.sh/cli/getting-started Register a new project by cloning it from a Git repository. Specify a name, local path, and parent directory. ```bash superset projects create --name "my-app" --local \ --clone https://github.com/org/my-app.git \ --parent-dir ~/code ``` -------------------------------- ### Superset CLI: Human-readable Who Am I Output Source: https://docs.superset.sh/llms-full.txt Example of the human-readable output from the Superset CLI `auth whoami` command. ```text Signed in as Satya Patel (you@example.com) Organization: Acme Auth: Session (expires in 32 min) ``` -------------------------------- ### Superset CLI: Human-readable Logout Output Source: https://docs.superset.sh/llms-full.txt Example of the human-readable output after a successful Superset CLI logout. ```text Logged out. ``` -------------------------------- ### Create Superset Project from Local Repo Source: https://docs.superset.sh/cli/host-server Imports an existing local repository to create a new Superset project. This is used on the first machine to register a repo. ```bash superset projects create \ --name "My Project" \ --local \ --import ~/code/existing-repo ``` -------------------------------- ### superset automations prompt get Source: https://docs.superset.sh/llms-full.txt Retrieve and print an automation's prompt body to standard output. ```APIDOC ## superset automations prompt get ### Description Print an automation's prompt body to stdout. The output is the raw prompt with no trailing newline added, so `prompt get` and `prompt set` round-trip byte-exactly. ### Method `superset automations prompt get ` ### Parameters #### Arguments - **id** (string) - Required - Automation ID. ### Request Example ```bash # Read to a file superset automations prompt get aut_… > prompt.md # Verify a push landed superset automations prompt get aut_… | diff - ./prompt.md ``` ``` -------------------------------- ### superset automations get Source: https://docs.superset.sh/llms-full.txt Retrieves the metadata for a specific automation by its ID. Does not include the prompt body, which can be fetched separately. ```APIDOC ## superset automations get ### Description Get an automation's metadata. The prompt body is omitted — use [`automations prompt get`](#superset-automations-prompt-get-id) to read it. Use [`automations logs`](#superset-automations-logs-id) for run history. ### Method CLI Command ### Endpoint N/A (CLI command) ### Parameters #### Arguments - **id** (string) - Required - Automation ID. ### Response #### Success Response Output is an Automation object. #### Response Example (Automation object) ```