@sap/joule-studio-cli

Joule Studio CLI

Installing @sap/joule-studio-cli gives you two commands:

joule — Joule Studio Legacy CLI

The joule command provides capabilities to:

• Compile the designtime artifact into a runtime artifact
• Deploy a digital assistant via its runtime artifact
• Test deployed Joule assistant
• Get a list of all deployed digital assistants
• Delete deployed digital assistants
• Launch deployed digital assistants
• Run static lint checks and convert YAML test scenarios into .feature files

Installation

You can install both CLIs globally using npm.

Requirements

• Node.js v22 – v24
• For Linux: libsecret or a compatible keyring (for secure credential storage)

Install

npm install -g @sap/joule-studio-cli

Update

npm install -g -f @sap/joule-studio-cli

Uninstall

npm uninstall -g @sap/joule-studio-cli

Usage

Important Security Notice

The Joule Studio Command Line Interface is designed solely for testing and development purposes and is not intended to manage personal or confidential data. Users should ensure that any content provided for testing contains only non-real, non-sensitive information to maintain security and privacy.

Available Commands

Run joule help or joule <command> --help for full usage details.

Global options

Login

To log in to a production landscape, run:

joule login

The API URL will be automatically determined based on the authentication URL provided. To connect to a custom API URL, use:

joule login --apiurl <apiurl>.

Example Workflow

• Log in to Joule:

  joule login

• Compile designtime artifacts into runtime artifacts:

  joule compile

• Deploy the digital assistant:

  joule deploy ./da.sapdas.yaml

• Launch it in the web client:

  joule launch my_assistant_name

jl — Joule Work CLI

The jl command provides capabilities to:

• Create and manage solutions composed of typed assets (agents, MCP servers, workflows, etc.)
• Set up pro-code projects for AI coding agents
• Validate and build solution artifacts
• Deploy solutions to Joule Studio runtime
• Manage assets (create, delete) across all supported asset types
• Interact with MCP servers (list, inspect tools, call tools)
• Send agent-to-agent messages

Note: jl requires Node.js ≥ 24.

Usage

jl login <joule-studio-url>                        # log in
jl solution create --name <name>                   # create a solution
jl solution validate                               # validate
jl solution build                                  # build zip
jl solution deploy                                 # deploy to backend

Example Workflow

Log in to the backend:

jl login 'https://my-backend.cfapps.eu12.hana.ondemand.com?issuerUrl=https://myias.accounts.cloud.sap&clientId=<client-id>&appTid=<app-tid>'

Where do I find this URL? In your Joule Studio tenant, go to Settings → Develop and copy the URL shown there.

Create a solution and add an asset:

jl solution create --name my-solution
jl asset create agent --name my-agent

Validate, build, and deploy:

jl solution validate
jl solution build
jl solution deploy

The following are required depending on which skills you use after running jl init <agent>:

See the CLI Reference for all commands and options.

Built on @sap/joule-studio-cli-core-v2.

Documentation

Full product documentation is available at: SAP Help Portal – Joule Studio Tools

License

Copyright © SAP SE

This project is licensed under the SAP Developer License