LogoLogo
  • Welcome to Composabl
  • Get Started
  • Reference
    • CLI Reference
    • SDK Reference
    • Glossary
    • Sample Use Cases
  • Tutorials
    • Industrial Mixer
      • Get Started
      • Deep Reinforcement Learning
      • Strategy Pattern
      • Strategy Pattern with a Perception Layer
      • Plan-Execute Pattern
  • Establish a Simulation Environment
    • Simulation Overview
    • Connect a Simulator to Composabl
    • Composabl Simulation API
  • Build Multi-Agent Systems
    • Anatomy of a Multi-Agent System
    • Create a Use Case
    • Set Goals, Constraints, and Success Criteria
    • Create Skill Agents
      • Create Skill Agents
      • Create Skill Agents with Rewards Using the SDK
      • Configure Programmed Algorithms as Skill Agents
      • Configure API Connections to Third-Party Software as Skill Agents
    • Orchestrate Skill Agents
    • Configure Scenarios
    • Add a Perception Layer
      • Create a New Perceptor
      • Configure an ML Model as a Perceptor
      • Configure an LLM Model as a Perceptor
    • Publish Skill Agent Components to the UI
  • Train Agents
    • Submit a Training Job through the UI
    • Analyze Agent System Behavior
      • View Training Session Information
      • Analyze Data in Detail with the Historian
  • Evaluate Performance
    • Set KPI and ROI
    • Analyze Data
  • Deploy Agents
    • Access a Trained Agent System
    • Deploy an Agent System in a Container
    • Deploy an Agent System as an API
    • Connect Runtime Container to Your Operation
    • Connecting to Agent System Runtime and Plotting Results of Agent System Operations
  • clusters
    • Creating a Cluster
      • Manual
      • Automated
      • Azure
    • Connecting a Cluster
  • Troubleshooting
    • Resolving Certificate Issues for Installing the Composabl SDK on WSL
Powered by GitBook
On this page
  • Login
  • Agent
  • Sim (composabl sim)
  • Perceptor (composabl perceptor)
  • Skill (composabl skill)
  • Selector (composabl selector)
  • Job (composabl job)
Export as PDF
  1. Reference

CLI Reference

PreviousGet StartedNextSDK Reference

Last updated 5 months ago

Below, you can find the commands available in the Composabl CLI.

Login

Command
Description

composabl login

Login to the Composabl platform

Agent

Command
Description

composabl agent train --json-path <PATH>

Train the agent based on the JSON Structure provided

composabl agent visualize

Visualize the agent structure

Sim (composabl sim)

Command
Description

composabl sim new --name <NAME> --description <DESCRIPTION> --location <PATH>

Create a new sim template. This will create the boilerplate required to submit a sim

composabl sim validate <PATH>

Validates the simulator at the given path

composabl sim validate --path <PATH>

Validates the simulator at the given path

composabl sim validate --address <ADDRESS>

Validates the simulator running at the given address

composabl sim run <PATH>

Run the sim created through the command above locally (useful for development)

composabl sim list

List the sims associated with an organization in the Composabl UI

composabl sim list --local

List the Docker images for sims running locally

composabl sim status

Gives a status of currently running local sims

composabl sim stop --sim-id <SIM_ID>

Stop the running sim

composabl sim stop

Stop all the running sim

composabl sim mappings --address <ADDRESS> --image <IMAGE>

Based on the address or image, get the mappings for a Sim its observation and action space

Perceptor (composabl perceptor)

Command
Description

composabl perceptor new --name <NAME> --description <DESCRIPTION> --location <PATH>

Create a new perceptor template. This will create the boilerplate required to submit a perceptor

composabl perceptor publish <PATH>

Publish the perceptor to the NoCode app

Skill (composabl skill)

Command
Description

composabl skill new --name <NAME> --description <DESCRIPTION> --location <PATH>

Create a new skill template. This will create the boilerplate required to submit a skill

composabl skill publish <PATH>

Publish the skill to the NoCode app

Selector (composabl selector)

Command
Description

composabl selector new --name <NAME> --description <DESCRIPTION> --location <PATH>

Create a new selector template. This will create the boilerplate required to submit a selector

composabl selector publish <PATH>

Publish the selector to the NoCode app

Job (composabl job)

Command
Description

composabl job list

List the running jobs

composabl job stop <JOB_ID>

Stop the running job

composabl job submit --path <PATH> --job-id <JOB_ID> --json <JSON> --template-path <TEMPLATE_PATH>

Submit a job for training

Install the Composabl CLI