Skip to content
This repository was archived by the owner on Aug 7, 2025. It is now read-only.

Commit 1edcc23

Browse files
committed
.
1 parent 37e48d9 commit 1edcc23

File tree

1 file changed

+146
-46
lines changed

1 file changed

+146
-46
lines changed

docs/disco-cli-reference.md

Lines changed: 146 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,12 @@ sidebar_position: 5
88
<!-- commands -->
99
* [`disco apikeys:list`](#disco-apikeyslist)
1010
* [`disco apikeys:remove [PUBLICKEY]`](#disco-apikeysremove-publickey)
11+
* [`disco autocomplete [SHELL]`](#disco-autocomplete-shell)
1112
* [`disco deploy`](#disco-deploy)
13+
* [`disco deploy:cancel`](#disco-deploycancel)
1214
* [`disco deploy:list`](#disco-deploylist)
1315
* [`disco deploy:output`](#disco-deployoutput)
16+
* [`disco discos:list`](#disco-discoslist)
1417
* [`disco domains:add DOMAIN`](#disco-domainsadd-domain)
1518
* [`disco domains:list`](#disco-domainslist)
1619
* [`disco domains:remove DOMAIN`](#disco-domainsremove-domain)
@@ -45,6 +48,7 @@ sidebar_position: 5
4548
* [`disco postgres:addon:install`](#disco-postgresaddoninstall)
4649
* [`disco postgres:addon:remove`](#disco-postgresaddonremove)
4750
* [`disco postgres:addon:update`](#disco-postgresaddonupdate)
51+
* [`disco postgres:create`](#disco-postgrescreate)
4852
* [`disco postgres:databases:add`](#disco-postgresdatabasesadd)
4953
* [`disco postgres:databases:attach`](#disco-postgresdatabasesattach)
5054
* [`disco postgres:databases:detach`](#disco-postgresdatabasesdetach)
@@ -53,12 +57,12 @@ sidebar_position: 5
5357
* [`disco postgres:instances:add`](#disco-postgresinstancesadd)
5458
* [`disco postgres:instances:list`](#disco-postgresinstanceslist)
5559
* [`disco postgres:instances:remove`](#disco-postgresinstancesremove)
60+
* [`disco postgres:tunnel`](#disco-postgrestunnel)
5661
* [`disco projects:add`](#disco-projectsadd)
5762
* [`disco projects:list`](#disco-projectslist)
5863
* [`disco projects:move`](#disco-projectsmove)
5964
* [`disco projects:remove PROJECT`](#disco-projectsremove-project)
6065
* [`disco run [COMMAND]`](#disco-run-command)
61-
* [`disco runcommand [PROJECT] [COMMAND] [ARGS]`](#disco-runcommand-project-command-args)
6266
* [`disco scale SERVICES`](#disco-scale-services)
6367
* [`disco syslog:add [SYSLOGDESTINATION]`](#disco-syslogadd-syslogdestination)
6468
* [`disco syslog:list`](#disco-sysloglist)
@@ -111,6 +115,37 @@ EXAMPLES
111115

112116
_See code: [src/commands/apikeys/remove.ts](https://github.com/letsdiscodev/cli/blob/main/src/commands/apikeys/remove.ts)_
113117

118+
## `disco autocomplete [SHELL]`
119+
120+
Display autocomplete installation instructions.
121+
122+
```
123+
USAGE
124+
$ disco autocomplete [SHELL] [-r]
125+
126+
ARGUMENTS
127+
SHELL (zsh|bash|powershell) Shell type
128+
129+
FLAGS
130+
-r, --refresh-cache Refresh cache (ignores displaying instructions)
131+
132+
DESCRIPTION
133+
Display autocomplete installation instructions.
134+
135+
EXAMPLES
136+
$ disco autocomplete
137+
138+
$ disco autocomplete bash
139+
140+
$ disco autocomplete zsh
141+
142+
$ disco autocomplete powershell
143+
144+
$ disco autocomplete --refresh-cache
145+
```
146+
147+
_See code: [@oclif/plugin-autocomplete](https://github.com/oclif/plugin-autocomplete/blob/main/src/commands/autocomplete/index.ts)_
148+
114149
## `disco deploy`
115150

116151
deploy a project, a specific commit or a disco.json file
@@ -136,6 +171,30 @@ EXAMPLES
136171

137172
_See code: [src/commands/deploy.ts](https://github.com/letsdiscodev/cli/blob/main/src/commands/deploy.ts)_
138173

174+
## `disco deploy:cancel`
175+
176+
cancel a deployment for a project. if a deployment number is not specified, the latest deployment will be cancelled
177+
178+
```
179+
USAGE
180+
$ disco deploy:cancel --project <value> [--deployment <value>] [--disco <value>]
181+
182+
FLAGS
183+
--deployment=<value>
184+
--disco=<value>
185+
--project=<value> (required)
186+
187+
DESCRIPTION
188+
cancel a deployment for a project. if a deployment number is not specified, the latest deployment will be cancelled
189+
190+
EXAMPLES
191+
$ disco deploy:cancel --project mysite
192+
193+
$ disco deploy:cancel --project mysite --deployment 4
194+
```
195+
196+
_See code: [src/commands/deploy/cancel.ts](https://github.com/letsdiscodev/cli/blob/main/src/commands/deploy/cancel.ts)_
197+
139198
## `disco deploy:list`
140199

141200
list the deployments for a project
@@ -181,6 +240,23 @@ EXAMPLES
181240

182241
_See code: [src/commands/deploy/output.ts](https://github.com/letsdiscodev/cli/blob/main/src/commands/deploy/output.ts)_
183242

243+
## `disco discos:list`
244+
245+
list the discos
246+
247+
```
248+
USAGE
249+
$ disco discos:list
250+
251+
DESCRIPTION
252+
list the discos
253+
254+
EXAMPLES
255+
$ disco discos:list
256+
```
257+
258+
_See code: [src/commands/discos/list.ts](https://github.com/letsdiscodev/cli/blob/main/src/commands/discos/list.ts)_
259+
184260
## `disco domains:add DOMAIN`
185261

186262
add a domain name to the project
@@ -476,16 +552,18 @@ initializes a new server
476552
```
477553
USAGE
478554
$ disco init SSHSTRING [--version <value>] [--verbose] [--host <value>] [--local-image <value>]
479-
[--advertise-addr <value>] [--cloudflare-tunnel <value>]
555+
[--advertise-addr <value>] [--cloudflare-tunnel <value>] [-i <value>]
480556
481557
FLAGS
482-
--advertise-addr=<value> fixed IP address used to add nodes. defaults to resolving domain name of ssh connection
483-
--cloudflare-tunnel=<value> Cloudflare Tunnel token, if you want to run Disco behind a Cloudflare tunnel
484-
--host=<value> hostname to use, when installing using an internal IP for the SSH connection, e.g. disco
485-
init [email protected] --host disco.example.com
486-
--local-image=<value> local Docker image to upload and use (mostly for Disco development)
487-
--verbose show extra output
488-
--version=<value> [default: latest] version of disco daemon to install
558+
-i, --identity-file=<value> SSH key to use for authentication
559+
--advertise-addr=<value> fixed IP address used to add nodes. defaults to resolving domain name of ssh
560+
connection
561+
--cloudflare-tunnel=<value> Cloudflare Tunnel token, if you want to run disco behind a Cloudflare tunnel
562+
--host=<value> hostname to use, when installing using an internal IP for the SSH connection, e.g.
563+
disco init [email protected] --host disco.example.com
564+
--local-image=<value> local Docker image to upload and use (mostly for Disco development)
565+
--verbose show extra output
566+
--version=<value> [default: latest] version of disco daemon to install
489567
490568
DESCRIPTION
491569
initializes a new server
@@ -1001,6 +1079,28 @@ EXAMPLES
10011079

10021080
_See code: [src/commands/postgres/addon/update.ts](https://github.com/letsdiscodev/cli/blob/main/src/commands/postgres/addon/update.ts)_
10031081

1082+
## `disco postgres:create`
1083+
1084+
create a database for a project, ensuring addon and instance are installed
1085+
1086+
```
1087+
USAGE
1088+
$ disco postgres:create --project <value> --env-var <value> [--disco <value>]
1089+
1090+
FLAGS
1091+
--disco=<value>
1092+
--env-var=<value> (required) [default: DATABASE_URL]
1093+
--project=<value> (required)
1094+
1095+
DESCRIPTION
1096+
create a database for a project, ensuring addon and instance are installed
1097+
1098+
EXAMPLES
1099+
$ disco postgres:create
1100+
```
1101+
1102+
_See code: [src/commands/postgres/create.ts](https://github.com/letsdiscodev/cli/blob/main/src/commands/postgres/create.ts)_
1103+
10041104
## `disco postgres:databases:add`
10051105

10061106
add a Postgres database
@@ -1176,21 +1276,47 @@ EXAMPLES
11761276

11771277
_See code: [src/commands/postgres/instances/remove.ts](https://github.com/letsdiscodev/cli/blob/main/src/commands/postgres/instances/remove.ts)_
11781278

1279+
## `disco postgres:tunnel`
1280+
1281+
create a temporary tunnel to access Postgres through localhost
1282+
1283+
```
1284+
USAGE
1285+
$ disco postgres:tunnel --project <value> [--disco <value>] [--env-var <value>] [--port <value>]
1286+
1287+
FLAGS
1288+
--disco=<value>
1289+
--env-var=<value>
1290+
--port=<value>
1291+
--project=<value> (required)
1292+
1293+
DESCRIPTION
1294+
create a temporary tunnel to access Postgres through localhost
1295+
1296+
EXAMPLES
1297+
$ disco postgres:tunnel
1298+
```
1299+
1300+
_See code: [src/commands/postgres/tunnel.ts](https://github.com/letsdiscodev/cli/blob/main/src/commands/postgres/tunnel.ts)_
1301+
11791302
## `disco projects:add`
11801303

11811304
add a project
11821305

11831306
```
11841307
USAGE
1185-
$ disco projects:add --name <value> [--domain <value>] [--github <value>] [--branch <value>] [--disco <value>]
1308+
$ disco projects:add --name <value> --github <value> [--domain <value>] [--branch <value>] [--deployPublicRepo]
1309+
[--disco <value>]
11861310
11871311
FLAGS
1188-
--branch=<value> the branch of the repository to use
1189-
--disco=<value> server to use
1190-
--domain=<value> domain name where the app will be served, e.g. www.example.com
1191-
--github=<value> full name of the Github repository, including user or organization and repository name, e.g.
1192-
myuser/myproject
1193-
--name=<value> (required) project name
1312+
--branch=<value> the branch of the repository to use
1313+
--deployPublicRepo deploy a public repository without checking for GitHub access. Note that "git push" to the repo
1314+
will not trigger a new deployment
1315+
--disco=<value> server to use
1316+
--domain=<value> domain name where the app will be served, e.g. www.example.com
1317+
--github=<value> (required) full name of the Github repository, including user or organization and repository name,
1318+
e.g. myuser/myproject
1319+
--name=<value> (required) project name
11941320
11951321
DESCRIPTION
11961322
add a project
@@ -1292,32 +1418,6 @@ EXAMPLES
12921418

12931419
_See code: [src/commands/run.ts](https://github.com/letsdiscodev/cli/blob/main/src/commands/run.ts)_
12941420

1295-
## `disco runcommand [PROJECT] [COMMAND] [ARGS]`
1296-
1297-
run a service-level (e.g. postgres) command
1298-
1299-
```
1300-
USAGE
1301-
$ disco runcommand [PROJECT...] [COMMAND...] [ARGS...] [--timeout <value>] [--disco <value>]
1302-
1303-
ARGUMENTS
1304-
PROJECT... project to run command on
1305-
COMMAND... command to run
1306-
ARGS... args to pass to command
1307-
1308-
FLAGS
1309-
--disco=<value>
1310-
--timeout=<value> [default: 600]
1311-
1312-
DESCRIPTION
1313-
run a service-level (e.g. postgres) command
1314-
1315-
EXAMPLES
1316-
$ disco runcommand postgres db:add -- "--project flask"
1317-
```
1318-
1319-
_See code: [src/commands/runcommand.ts](https://github.com/letsdiscodev/cli/blob/main/src/commands/runcommand.ts)_
1320-
13211421
## `disco scale SERVICES`
13221422

13231423
scale one or multiple services from a project
@@ -1453,7 +1553,7 @@ _See code: [@oclif/plugin-update](https://github.com/oclif/plugin-update/blob/ma
14531553

14541554
## `disco volumes:export`
14551555

1456-
TODO describe the command here
1556+
export a volume
14571557

14581558
```
14591559
USAGE
@@ -1465,7 +1565,7 @@ FLAGS
14651565
--volume=<value> (required)
14661566
14671567
DESCRIPTION
1468-
TODO describe the command here
1568+
export a volume
14691569
14701570
EXAMPLES
14711571
$ disco volumes:export
@@ -1475,7 +1575,7 @@ _See code: [src/commands/volumes/export.ts](https://github.com/letsdiscodev/cli/
14751575

14761576
## `disco volumes:import`
14771577

1478-
TODO describe the command here
1578+
import a volume
14791579

14801580
```
14811581
USAGE
@@ -1487,7 +1587,7 @@ FLAGS
14871587
--volume=<value> (required)
14881588
14891589
DESCRIPTION
1490-
TODO describe the command here
1590+
import a volume
14911591
14921592
EXAMPLES
14931593
$ disco volumes:import

0 commit comments

Comments
 (0)