CLICommand referencegithub
github
Commands, arguments, and options for openship github.
See the workflow guide for examples. Global flags such as --json go before the command; see global options.
openship github
Connect GitHub, browse repositories and manage deployment sources
openship github [options] [command]| Subcommand | Purpose |
|---|---|
status | Show available connection methods and current GitHub access |
home | Show connected accounts and recent repositories |
local-status | Inspect GitHub credentials on the selected Openship instance |
connect [options] | Begin a connection; follow the returned browser, device or installation instructions |
poll [options] | Check whether a connection attempt completed |
claim [options] <installation> | Select an installation offered to the authenticated user |
token <file> | Set the instance's GitHub personal token (self-hosted administrators) |
disconnect [options] | Disconnect a GitHub credential source |
repo | Browse and manage repositories available to this connection |
source | Configure self-hosted GitHub Apps and their installations |
openship github claim
Select an installation offered to the authenticated user
openship github claim [options] <installation>| Argument | Meaning |
|---|---|
installation | Installation ID offered by github connect |
| Option | Meaning |
|---|---|
--state <state> | Exact connection attempt state |
openship github connect
Begin a connection; follow the returned browser, device or installation instructions
openship github connect [options]| Option | Meaning |
|---|---|
--source <method> | Connection method (choices: "oauth", "cli") |
--state <state> | Resume this connection attempt |
openship github disconnect
Disconnect a GitHub credential source
openship github disconnect [options]| Option | Meaning |
|---|---|
--source <method> | Credential to disconnect (choices: "oauth", "cli", "all", default: "all") |
-y, --yes | Confirm disconnection |
openship github home
Show connected accounts and recent repositories
openship github home [options]openship github local-status
Inspect GitHub credentials on the selected Openship instance
openship github local-status [options]openship github poll
Check whether a connection attempt completed
openship github poll [options]| Option | Meaning |
|---|---|
--state <state> | Attempt state from github connect |
openship github status
Show available connection methods and current GitHub access
openship github status [options]openship github token
Set the instance's GitHub personal token (self-hosted administrators)
openship github token [options] <file>| Argument | Meaning |
|---|---|
file | Token file, or - for stdin |