Skip to content

Interfaces

EnableOpts

Options for enableWorkspaces.

optional acceptTerms?: boolean

Accept, on the organization’s behalf, the legal documents it has not accepted yet. Pass true only when the person running your program has read and agreed to them (workspacesStatus() lists them, with URLs). Without it, an organization with unaccepted terms rejects with TermsNotAcceptedError.


optional githubAccount?: string

The GitHub organization or user to link (default: the GitHub user who authorizes in the browser).


optional githubPort?: number

The loopback port for GitHub’s redirect (default 8989).


optional instance?: string

The organization ID. If unset, $CHAINCTL_SANDBOX_INSTANCE is used, and failing that the only organization you belong to.

SetupOpts.instance


optional openBrowser?: boolean

false: don’t start the GitHub authorization; reject with GitHubLinkRequiredError if a link is needed.


optional openUrl?: (url) => boolean | void | Promise<boolean | void>

Opens the GitHub page instead of the default browser launcher.

string

boolean | void | Promise<boolean | void>


optional out?: (message) => void

Receives instructions during the GitHub authorization (default: written to stderr).

string

void


optional tokenSource?: TokenSource

Mints tokens for the platform API (default: the saved login).

SetupOpts.tokenSource