oz0 connection start
For: Operators and developers looking up a command.
Start a connection's steps and print the URL to open in your browser, within 15 minutes; it works once. The steps go through the other system's pages, such as GitHub's to register and install an app, and end at the edge's HTTPS port (--public-edge-url on the server), which must be reachable from your browser.
A connected connection stays in effect until a new flow from its restart step (connection show) is done; starting from an earlier step, such as registering another GitHub App, needs --replace and cuts it off at once. A param with choices picks which steps run (connection show says when each runs), such as account=user for a GitHub App on your own account instead of an organization's.
When the last step is done, the functions the connection runs after connecting start as tool jobs (connection show lists them). Some steps run on the edge's own page instead: a link that creates your own app on the other system with everything filled in, values to copy into its settings, and fields you paste back there, never here. Each is checked before the next step. The steps go to stderr as they start; --wait follows them.
Usage
oz0 connection start <connection> [flags]
Flags
| Flag | Type | Default | Description |
|---|---|---|---|
--from-step | string | start at this step, such as install to install a registered app on another account | |
--open | bool | open the URL in the default browser, if it is an http or https address | |
--param | stringToString | [] | a param of the connection, name=value; repeatable (default: the ones set before) |
--quiet | bool | print only the URL | |
--replace | bool | replace a connected connection from a step before its restart step; its calls get the fallback secret until the new flow is done | |
--return-url | string | a page that says so | where the browser goes when the steps are done: an address on the edge, the web console or one of the tenant's CORS origins |
--tenant | string | default | tenant |
--wait | duration | follow the steps and their checks until the connection is connected or fails, at most this long, such as 15m |
Inherited flags
| Flag | Type | Default | Description |
|---|---|---|---|
--context | string | $OZ0_CONTEXT or <config dir>/orchestrator-zero/context.json | CLI context file written by server init |
--log-level | string | info | log level: debug, info, warn or error |
See all oz0 commands and the global flags.