migration

See the workflow guide for examples. Global flags such as --json go before the command; see global options.

openship migration

Discover, import, move and copy Docker workloads between authorized servers, including Cloud

openship migration [options] [command]

Subcommand	Purpose
`source`	Manage migration-only SSH sources; these cannot run general server commands
`scan [options] <server>`	Read Docker services, container IDs, routes and volumes with environment values masked
`repo-compose [options] [file]`	Read repository Compose services with environment values masked
`preview [options] [file]`	Inspect transfer size, blocked services, conflicts and downtime before moving
`adopt [options] [file]`	Register discovered services in place on a self-hosted controller
`reimport [options] [file]`	Recover a scanned orphaned Openship project with its original ID
`start [options] [file]`	Start the reviewed Docker migration; keep killOriginals false to review cutover
`project [options] [file]`	Move or copy an existing project; the run waits for explicit cutover
`reveal-env [options] [file]`	Print only the requested environment keys from one source container (secrets)
`get <id>`	Read durable state, logs, transfer progress, pending prompts and cutover token
`active <server>`	Find an active run before starting or reattaching to work
`list [options]`	List up to 50 runs for a server or project
`events <id>`	Reattach to a migration's progress without restarting it
`respond [options] <id>`	Respond to the exact pending decision returned by migration get
`resume [options] <id> [file]`	Resume a partial run with reviewed path overrides or skips
`cutover [options] <id>`	Confirm the reviewed target; never invents a cutover token or changes the retirement choice
`cancel [options] <id>`	Request cancellation and rollback; poll migration get until it finishes
`cleanup-target [options] <id>`	Delete target volumes copied by a failed migration; source data remains
`remove [options] <id>`	Delete a terminal run's history record; retain the migrated project and data

openship migration active

Find an active run before starting or reattaching to work

openship migration active [options] <server>

openship migration adopt

openship migration adopt [options] [file]

Argument	Meaning
`file`	JSON input file, or - for stdin

Option	Meaning
`--schema`	Print the accepted JSON schema without making a request
`-y, --yes`	Confirm this operation

openship migration cancel

Request cancellation and rollback; poll migration get until it finishes

openship migration cancel [options] <id>

Option	Meaning
`-y, --yes`	Confirm operation

openship migration cleanup-target

Delete target volumes copied by a failed migration; source data remains

openship migration cleanup-target [options] <id>

Option	Meaning
`-y, --yes`	Confirm operation

openship migration cutover

Confirm the reviewed target; never invents a cutover token or changes the retirement choice

openship migration cutover [options] <id>

Option	Meaning
`--token-file <file>`	This run's confirmation token, or - for stdin
`--originals <choice>`	Retain source containers or authorize their destruction (choices: "retain", "retire")
`-y, --yes`	Confirm cutover

openship migration events

Reattach to a migration's progress without restarting it

openship migration events [options] <id>

openship migration get

Read durable state, logs, transfer progress, pending prompts and cutover token

openship migration get [options] <id>

openship migration list

List up to 50 runs for a server or project

openship migration list [options]

Option	Meaning
`--server <id>`	Source or target server
`--project <id>`	Project ID

openship migration preview

Inspect transfer size, blocked services, conflicts and downtime before moving

openship migration preview [options] [file]

Argument	Meaning
`file`	JSON input file, or - for stdin

Option	Meaning
`--schema`	Print the accepted JSON schema without making a request

openship migration project

Move or copy an existing project; the run waits for explicit cutover

openship migration project [options] [file]

Argument	Meaning
`file`	JSON input file, or - for stdin

Option	Meaning
`--schema`	Print the accepted JSON schema without making a request
`-y, --yes`	Confirm this operation

openship migration reimport

Recover a scanned orphaned Openship project with its original ID

openship migration reimport [options] [file]

Argument	Meaning
`file`	JSON input file, or - for stdin

Option	Meaning
`--schema`	Print the accepted JSON schema without making a request
`-y, --yes`	Confirm this operation

openship migration remove

Delete a terminal run's history record; retain the migrated project and data

openship migration remove [options] <id>

Option	Meaning
`-y, --yes`	Confirm operation

openship migration repo-compose

Read repository Compose services with environment values masked

openship migration repo-compose [options] [file]

Argument	Meaning
`file`	JSON input file, or - for stdin

Option	Meaning
`--schema`	Print the accepted JSON schema without making a request

openship migration respond

Respond to the exact pending decision returned by migration get

openship migration respond [options] <id>

Option	Meaning
`--prompt <id>`	Current pending prompt ID
`--action <id>`	An action offered by that prompt
`-y, --yes`	Confirm the offered action

openship migration resume

Resume a partial run with reviewed path overrides or skips

openship migration resume [options] <id> [file]

Argument	Meaning
`id`	Resource ID
`file`	JSON input file, or - for stdin

Option	Meaning
`--schema`	Print the accepted JSON schema without making a request
`-y, --yes`	Confirm this operation

openship migration reveal-env

Print only the requested environment keys from one source container (secrets)

openship migration reveal-env [options] [file]

Argument	Meaning
`file`	JSON input file, or - for stdin

Option	Meaning
`--schema`	Print the accepted JSON schema without making a request
`-y, --yes`	Confirm this operation

openship migration scan

Read Docker services, container IDs, routes and volumes with environment values masked

openship migration scan [options] <server>

Option	Meaning
`--flat-docker`	Include managed containers in the Docker scan
`--follow`	Stream scan progress
`--timeout <ms>`	Bound the streaming scan (default: 120000)

openship migration source

Manage migration-only SSH sources; these cannot run general server commands

openship migration source [options] [command]

Subcommand	Purpose
`list`	List registered migration sources
`test [options] [file]`	Verify source access and return its SSH fingerprint without saving it
`add [options] [file]`	Connect a source using credentials from a JSON file or stdin
`remove [options] <id>`	Delete saved migration access; retain source workloads and data

openship migration source add

Connect a source using credentials from a JSON file or stdin

openship migration source add [options] [file]

Argument	Meaning
`file`	JSON input file, or - for stdin

Option	Meaning
`--schema`	Print the accepted JSON schema without making a request

openship migration source list

List registered migration sources

openship migration source list [options]

openship migration source remove

Delete saved migration access; retain source workloads and data

openship migration source remove [options] <id>

Option	Meaning
`-y, --yes`	Confirm disconnect

openship migration source test

Verify source access and return its SSH fingerprint without saving it

openship migration source test [options] [file]

Argument	Meaning
`file`	JSON input file, or - for stdin

Option	Meaning
`--schema`	Print the accepted JSON schema without making a request

openship migration start

Start the reviewed Docker migration; keep killOriginals false to review cutover

openship migration start [options] [file]

Argument	Meaning
`file`	JSON input file, or - for stdin

Option	Meaning
`--schema`	Print the accepted JSON schema without making a request
`-y, --yes`	Confirm this operation

On this page