All apps/Leapp CLI

Leapp CLI

leapp-cli

A command-line interface for Leapp cloud access management.

Runs as leapp|macOS, Linux, Windows|docs.leapp.cloud

Command form

ai-draft · 5 tasks · 13 fields

List, start and stop Leapp cloud access sessions. Session creation, profiles, integrations and workspaces are left out.

Opens the form; the finished command lands at your prompt, unrun
otty gui leapp-cli

leapp session list

List sessions

Show sessions with their properties.

List sessionsExample values, fixed in this page — nothing here reaches a terminal
Basic
Extra columns*
-x
Filter
string
Sort by
string
TasksEach one presets the form for one job
List with extra columns
extendedfiltersort
ParametersOnly these flags are editable in the form
Extra columns
boolean
-x
Filter
Case-sensitive partial match such as name=foo.
string
--filter
Sort by
Property name; prepend - for descending.
string
--sort
Output format
enum
--outputcsvjsonyaml
Hide table header
boolean
--no-header

leapp session start

Start a session

Start a Leapp session by name or id.

Start a sessionExample values, fixed in this page — nothing here reaches a terminal
Basic
Session name*
string
Advanced
Fail instead of prompting
--noInteractive
TasksEach one presets the form for one job
Start a session by name
session_nameno_interactive
Start a session by id
session_id
ParametersOnly these flags are editable in the form
Session name
Leave empty to choose interactively.
string · positional 0
Session id
Find ids with leapp session list -x.
string
--sessionId
Session role
string
--sessionRole
Fail instead of prompting
boolean
--noInteractive

leapp session stop

Stop a session

Stop a Leapp session by name or id.

Stop a sessionExample values, fixed in this page — nothing here reaches a terminal
Basic
Session name*
string
Advanced
Fail instead of prompting
--noInteractive
TasksEach one presets the form for one job
Stop a session by name
session_nameno_interactive
Stop a session by id
session_id
ParametersOnly these flags are editable in the form
Session name
Leave empty to choose interactively.
string · positional 0
Session id
Find ids with leapp session list -x.
string
--sessionId
Session role
string
--sessionRole
Fail instead of prompting
boolean
--noInteractive
SourcesEvery flag above is checked against these
doc
$ leapp session list [--columns <value> | -x] [--sort <value>] [--filter <value>] [--output csv|json|yaml | [--csv | --no-truncate]] [--no-header | ] -x, --extended show extra columns --columns=<value> only show provided columns (comma-separated) --csv output is csv format [alias: --output=csv] --filter=<value> filter property by part…
help0.1.65

github.com

doc
$ leapp session start [SESSIONNAME] [--sessionId <value>] [--sessionRole <value>] [--noInteractive] SESSIONNAME Name of the Leapp session --noInteractive If the specified session is not unique or doesn't exist, throw an error without starting the interactive session selection mode --sessionId=<value> Session Id to identify the session in Leapp, re…
help0.1.65

github.com

doc
$ leapp session stop [SESSIONNAME] [--sessionId <value>] [--sessionRole <value>] [--noInteractive] SESSIONNAME Name of the Leapp session --noInteractive If the specified session is not unique or doesn't exist, throw an error without starting the interactive session selection mode --sessionId=<value> Session Id to identify the session in Leapp, rec…
help0.1.65

github.com

Before it fills your prompt, Otty checks the installed leapp against its version. A form that does not match your version is not offered.