otty / apps

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

Open form in Otty otty.toml

Sync rules

What travels, what stays, what never leaves

Leapp CLI in your home directory Every rule on this page, by file

· ~/.Leapp/Leapp-lock.json Sync

Only what the catalog names. A directory that syncs brings everything inside it except what is listed as excluded here.

apps/leapp-cli/otty.tomlThe file this page is generated from

id = "leapp-cli"

name = "Leapp CLI"

homepage = "https://docs.leapp.cloud/"

description = "A command-line interface for Leapp cloud access management."

executables = ["leapp"]

[dotfiles]

# Leapp's official application-data documentation lists ~/.Leapp on macOS,

# Linux, and Windows, and identifies Leapp-lock.json as the encrypted actual

# configuration. The version marker and logs are state, so only the lock file

# is carried.

# https://docs.leapp.cloud/0.12.2/troubleshooting/app-data/

paths = ["~/.Leapp/Leapp-lock.json"]

secret = []

[commands]

format = 1

label = "leapp"

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

quality = "ai-draft"

parser = { end_of_options = "--", interleave = "permute", long_equals = true, short_attached = false, short_bundles = false }

[[commands.subcommand]]

path = ["session", "list"]

label = "List sessions"

description = "Show sessions with their properties."

[[commands.subcommand.source]]

id = "doc"

kind = "help"

url = "https://github.com/Noovolari/leapp/blob/master/packages/cli/scopes/session.md"

revision = "0.1.65"

evidence = """

-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 partial string matching, ex: name=foo

--no-header hide table header from output

--no-truncate do not truncate output to fit screen

--output=<option> output in a more machine friendly format <options: csv|json|yaml>

--sort=<value> property to sort by (prepend '-' for descending)

"""

[[commands.subcommand.field]]

id = "extended"

label = "Extra columns"

type = "boolean"

option = ["-x"]

sources = ["doc"]

[[commands.subcommand.field]]

id = "filter"

label = "Filter"

description = "Case-sensitive partial match such as name=foo."

type = "string"

option = ["--filter"]

sources = ["doc"]

[[commands.subcommand.field]]

id = "sort"

label = "Sort by"

description = "Property name; prepend - for descending."

type = "string"

option = ["--sort"]

sources = ["doc"]

[[commands.subcommand.field]]

id = "output"

label = "Output format"

type = "enum"

option = ["--output"]

choices = [{ value = "csv", label = "CSV" }, { value = "json", label = "JSON" }, { value = "yaml", label = "YAML" }]

sources = ["doc"]

[[commands.subcommand.field]]

id = "no_header"

label = "Hide table header"

type = "boolean"

option = ["--no-header"]

sources = ["doc"]

[[commands.subcommand.task]]

id = "list_extended"

label = "List with extra columns"

fields = ["extended", "filter", "sort"]

required = ["extended"]

set = { extended = [true] }

[[commands.subcommand.group]]

id = "basic"

label = "Basic"

fields = ["extended", "filter", "sort"]

[[commands.subcommand.group]]

id = "advanced"

label = "Advanced"

fields = ["output", "no_header"]

[[commands.subcommand]]

path = ["session", "start"]

label = "Start a session"

description = "Start a Leapp session by name or id."

[[commands.subcommand.source]]

id = "doc"

kind = "help"

url = "https://github.com/Noovolari/leapp/blob/master/packages/cli/scopes/session.md"

revision = "0.1.65"

evidence = """

$ 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, recover it with $leapp session list -x

--sessionRole=<value> Session Role of one or more sessions in Leapp

"""

[[commands.subcommand.field]]

id = "session_name"

label = "Session name"

description = "Leave empty to choose interactively."

type = "string"

position = 0

sources = ["doc"]

[[commands.subcommand.field]]

id = "session_id"

label = "Session id"

description = "Find ids with leapp session list -x."

type = "string"

option = ["--sessionId"]

sources = ["doc"]

[[commands.subcommand.field]]

id = "session_role"

label = "Session role"

type = "string"

option = ["--sessionRole"]

sources = ["doc"]

[[commands.subcommand.field]]

id = "no_interactive"

label = "Fail instead of prompting"

type = "boolean"

option = ["--noInteractive"]

sources = ["doc"]

[[commands.subcommand.task]]

id = "by_name"

label = "Start a session by name"

fields = ["session_name", "no_interactive"]

required = ["session_name"]

[[commands.subcommand.task]]

id = "by_id"

label = "Start a session by id"

fields = ["session_id"]

required = ["session_id"]

[[commands.subcommand.group]]

id = "basic"

label = "Basic"

fields = ["session_name", "session_id"]

[[commands.subcommand.group]]

id = "advanced"

label = "Advanced"

fields = ["session_role", "no_interactive"]

[[commands.subcommand]]

path = ["session", "stop"]

label = "Stop a session"

description = "Stop a Leapp session by name or id."

[[commands.subcommand.source]]

id = "doc"

kind = "help"

url = "https://github.com/Noovolari/leapp/blob/master/packages/cli/scopes/session.md"

revision = "0.1.65"

evidence = """

$ 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, recover it with $leapp session list -x

--sessionRole=<value> Session Role of one or more sessions in Leapp

"""

[[commands.subcommand.field]]

id = "session_name"

label = "Session name"

description = "Leave empty to choose interactively."

type = "string"

position = 0

sources = ["doc"]

[[commands.subcommand.field]]

id = "session_id"

label = "Session id"

description = "Find ids with leapp session list -x."

type = "string"

option = ["--sessionId"]

sources = ["doc"]

[[commands.subcommand.field]]

id = "session_role"

label = "Session role"

type = "string"

option = ["--sessionRole"]

sources = ["doc"]

[[commands.subcommand.field]]

id = "no_interactive"

label = "Fail instead of prompting"

type = "boolean"

option = ["--noInteractive"]

sources = ["doc"]

[[commands.subcommand.task]]

id = "by_name"

label = "Stop a session by name"

fields = ["session_name", "no_interactive"]

required = ["session_name"]

[[commands.subcommand.task]]

id = "by_id"

label = "Stop a session by id"

fields = ["session_id"]

required = ["session_id"]

[[commands.subcommand.group]]

id = "basic"

label = "Basic"

fields = ["session_name", "session_id"]

[[commands.subcommand.group]]

id = "advanced"

label = "Advanced"

fields = ["session_role", "no_interactive"]

Use it with your dotfile manager

Same data, in the shape your tool already reads

Opens Otty and adds this tool to what it syncs

Opens otty://sync/add/leapp-cli. Otty ships with this catalog, so the link only has to name the tool — nothing is downloaded.

Every one of these is generated from the same rules as this page.