ghostdock 0.0.13 → 0.0.15
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cli-reference.md +184 -6
- package/dist/cli.md +30 -2
- package/dist/index.js +1082 -193
- package/package.json +1 -1
package/dist/cli-reference.md
CHANGED
|
@@ -118,17 +118,19 @@ MCP tool: `images_add`.
|
|
|
118
118
|
|
|
119
119
|
### `ghostdock images add-compose`
|
|
120
120
|
|
|
121
|
-
Add Compose
|
|
121
|
+
Add a Compose project to the organization’s image catalog. Give its files, or a reference: a Compose project published as an OCI artifact (oci://…), used through include: with an optional override. ghostdock.* service labels (of the files, or of the override) become its manifest. Fails if the name is taken.
|
|
122
122
|
|
|
123
123
|
```
|
|
124
|
-
ghostdock images add-compose --name <string>
|
|
124
|
+
ghostdock images add-compose --name <string> [flags]
|
|
125
125
|
```
|
|
126
126
|
|
|
127
127
|
| Argument | Description |
|
|
128
128
|
| --- | --- |
|
|
129
|
-
| `--name <string>` | Image name, unique in the organization. Required. |
|
|
130
|
-
| `--files <object>` | Compose files by file name. Must include docker-compose.yml/yaml or compose.yml/yaml. (JSON object) Required. |
|
|
131
129
|
| `--org <string>` | Organization id or slug, from organizations list. Ids survive renames; slugs change when the organization is renamed. Defaults to GHOSTDOCK_ORG, then `organizations use`. |
|
|
130
|
+
| `--name <string>` | Image name, unique in the organization. Required. |
|
|
131
|
+
| `--files <object>` | Compose files by file name. Must include docker-compose.yml/yaml or compose.yml/yaml. (JSON object) |
|
|
132
|
+
| `--reference <string>` | A published Compose project instead of files, e.g. oci://docker.io/ghostdockhq/vm-compose:ubuntu-26.04. |
|
|
133
|
+
| `--override <string>` | With reference: a Compose file merged into it (services, environment, labels). |
|
|
132
134
|
|
|
133
135
|
MCP tool: `images_add_compose`.
|
|
134
136
|
|
|
@@ -194,7 +196,7 @@ MCP tool: `images_remove`.
|
|
|
194
196
|
|
|
195
197
|
### `ghostdock images update-compose`
|
|
196
198
|
|
|
197
|
-
Replace a catalog Compose image’s files and/or name. Re-parses its labels.
|
|
199
|
+
Replace a catalog Compose image’s files, reference, override and/or name. Re-parses its labels.
|
|
198
200
|
|
|
199
201
|
```
|
|
200
202
|
ghostdock images update-compose <image-id> [flags]
|
|
@@ -205,6 +207,8 @@ ghostdock images update-compose <image-id> [flags]
|
|
|
205
207
|
| `<image-id>` | Catalog image id, from images list or images get. Required. |
|
|
206
208
|
| `--org <string>` | Organization id or slug, from organizations list. Ids survive renames; slugs change when the organization is renamed. Defaults to GHOSTDOCK_ORG, then `organizations use`. |
|
|
207
209
|
| `--files <object>` | New Compose files by file name. Omit to keep the current files. (JSON object) |
|
|
210
|
+
| `--reference <string>` | A new reference (oci://…): the image becomes a Compose reference. |
|
|
211
|
+
| `--override <string>` | A reference’s new override; null removes it. |
|
|
208
212
|
| `--name <string>` | New image name. Omit to keep it. |
|
|
209
213
|
|
|
210
214
|
MCP tool: `images_update_compose`.
|
|
@@ -749,7 +753,9 @@ ghostdock sandboxes commands get <command-id> --sandbox-id <string> --session-id
|
|
|
749
753
|
| `<command-id>` | Command id returned by sandboxes commands run. Required. |
|
|
750
754
|
| `--org <string>` | Organization id or slug, from organizations list. Ids survive renames; slugs change when the organization is renamed. Defaults to GHOSTDOCK_ORG, then `organizations use`. |
|
|
751
755
|
| `--sandbox-id <string>` | Sandbox name (e.g. quiet-harbor) or id, from sandboxes list or sandboxes create. Names are unique within the organization. Required. |
|
|
756
|
+
| `--container <string>` | Container to work in, by name, from sandboxes containers list. Default: the sandbox’s default container, else the one running container. With several running and no default the call fails and lists them. |
|
|
752
757
|
| `--session-id <string>` | Session id returned by sandboxes commands run together with the commandId. Required. |
|
|
758
|
+
| `--start` | Start the container first when it is not running, without asking. |
|
|
753
759
|
|
|
754
760
|
MCP tool: `sandboxes_commands_get`.
|
|
755
761
|
|
|
@@ -766,7 +772,9 @@ ghostdock sandboxes commands kill <command-id> --sandbox-id <string> --session-i
|
|
|
766
772
|
| `<command-id>` | Command id returned by sandboxes commands run. Required. |
|
|
767
773
|
| `--org <string>` | Organization id or slug, from organizations list. Ids survive renames; slugs change when the organization is renamed. Defaults to GHOSTDOCK_ORG, then `organizations use`. |
|
|
768
774
|
| `--sandbox-id <string>` | Sandbox name (e.g. quiet-harbor) or id, from sandboxes list or sandboxes create. Names are unique within the organization. Required. |
|
|
775
|
+
| `--container <string>` | Container to work in, by name, from sandboxes containers list. Default: the sandbox’s default container, else the one running container. With several running and no default the call fails and lists them. |
|
|
769
776
|
| `--session-id <string>` | Session id returned by sandboxes commands run together with the commandId. Required. |
|
|
777
|
+
| `--start` | Start the container first when it is not running, without asking. |
|
|
770
778
|
|
|
771
779
|
MCP tool: `sandboxes_commands_kill`.
|
|
772
780
|
|
|
@@ -783,8 +791,10 @@ ghostdock sandboxes commands logs <command-id> --sandbox-id <string> --session-i
|
|
|
783
791
|
| `<command-id>` | Command id returned by sandboxes commands run. Required. |
|
|
784
792
|
| `--org <string>` | Organization id or slug, from organizations list. Ids survive renames; slugs change when the organization is renamed. Defaults to GHOSTDOCK_ORG, then `organizations use`. |
|
|
785
793
|
| `--sandbox-id <string>` | Sandbox name (e.g. quiet-harbor) or id, from sandboxes list or sandboxes create. Names are unique within the organization. Required. |
|
|
794
|
+
| `--container <string>` | Container to work in, by name, from sandboxes containers list. Default: the sandbox’s default container, else the one running container. With several running and no default the call fails and lists them. |
|
|
786
795
|
| `--session-id <string>` | Session id returned by sandboxes commands run together with the commandId. Required. |
|
|
787
796
|
| `--offset <integer>` | Character offset to continue reading from. Default 0. |
|
|
797
|
+
| `--start` | Start the container first when it is not running, without asking. |
|
|
788
798
|
|
|
789
799
|
MCP tool: `sandboxes_commands_logs`.
|
|
790
800
|
|
|
@@ -800,13 +810,119 @@ ghostdock sandboxes commands run <sandbox-id> --command <string> [flags]
|
|
|
800
810
|
| --- | --- |
|
|
801
811
|
| `<sandbox-id>` | Sandbox name (e.g. quiet-harbor) or id, from sandboxes list or sandboxes create. Names are unique within the organization. Required. |
|
|
802
812
|
| `--org <string>` | Organization id or slug, from organizations list. Ids survive renames; slugs change when the organization is renamed. Defaults to GHOSTDOCK_ORG, then `organizations use`. |
|
|
813
|
+
| `--container <string>` | Container to work in, by name, from sandboxes containers list. Default: the sandbox’s default container, else the one running container. With several running and no default the call fails and lists them. |
|
|
803
814
|
| `--command <string>` | Shell command to run. Never include secret values: commands are logged. Required. |
|
|
804
815
|
| `--session-id <string>` | Session from sandboxes shells create, to keep cwd and environment from earlier commands. Omit for a one-off session. |
|
|
805
816
|
| `--cwd <string>` | Directory to run the command in. |
|
|
806
817
|
| `--wait-seconds <number>` | Seconds to wait before returning handles to poll: 1 to 120, default 120. |
|
|
818
|
+
| `--start` | Start the container first when it is not running, without asking. |
|
|
807
819
|
|
|
808
820
|
MCP tool: `sandboxes_commands_run`.
|
|
809
821
|
|
|
822
|
+
### `ghostdock sandboxes containers`
|
|
823
|
+
|
|
824
|
+
Containers of a sandbox’s Docker engine.
|
|
825
|
+
|
|
826
|
+
### `ghostdock sandboxes containers list`
|
|
827
|
+
|
|
828
|
+
List the containers of a sandbox, running or not. Each with state, health, restart policy, ports, Compose project and service, deletion protection, ghostdock.* labels, and which one is the default. A stopped sandbox lists none (it is not started for this).
|
|
829
|
+
|
|
830
|
+
```
|
|
831
|
+
ghostdock sandboxes containers list <sandbox-id> [flags]
|
|
832
|
+
```
|
|
833
|
+
|
|
834
|
+
| Argument | Description |
|
|
835
|
+
| --- | --- |
|
|
836
|
+
| `<sandbox-id>` | Sandbox name (e.g. quiet-harbor) or id, from sandboxes list or sandboxes create. Names are unique within the organization. Required. |
|
|
837
|
+
| `--org <string>` | Organization id or slug, from organizations list. Ids survive renames; slugs change when the organization is renamed. Defaults to GHOSTDOCK_ORG, then `organizations use`. |
|
|
838
|
+
|
|
839
|
+
MCP tool: `sandboxes_containers_list`.
|
|
840
|
+
|
|
841
|
+
### `ghostdock sandboxes containers logs`
|
|
842
|
+
|
|
843
|
+
Read a container’s output, as docker logs does. Oldest first, each line with its stream (stdout, stderr) and time. The last tail lines (default 200), or with after only the lines after that time: pass the last line’s time to follow. truncated says lines were left out. A stopped sandbox has none (it is not started for this).
|
|
844
|
+
|
|
845
|
+
```
|
|
846
|
+
ghostdock sandboxes containers logs <sandbox-id> <container> [flags]
|
|
847
|
+
```
|
|
848
|
+
|
|
849
|
+
| Argument | Description |
|
|
850
|
+
| --- | --- |
|
|
851
|
+
| `<sandbox-id>` | Sandbox name (e.g. quiet-harbor) or id, from sandboxes list or sandboxes create. Names are unique within the organization. Required. |
|
|
852
|
+
| `<container>` | Container, by name. Required. |
|
|
853
|
+
| `--org <string>` | Organization id or slug, from organizations list. Ids survive renames; slugs change when the organization is renamed. Defaults to GHOSTDOCK_ORG, then `organizations use`. |
|
|
854
|
+
| `--tail <integer>` | The last N lines (at most 5000). |
|
|
855
|
+
| `--after <string>` | Only lines after this time: the time of the last line already read. |
|
|
856
|
+
| `--follow` | Keep printing new lines until Ctrl-C. |
|
|
857
|
+
| `--timestamps` | Put each line's time in front of it. |
|
|
858
|
+
|
|
859
|
+
MCP tool: `sandboxes_containers_logs`.
|
|
860
|
+
|
|
861
|
+
### `ghostdock sandboxes containers protection`
|
|
862
|
+
|
|
863
|
+
Switch a container’s deletion protection on or off. A protected container cannot be removed or recreated (docker rm, compose down) until its protection is off. Starts the sandbox when needed.
|
|
864
|
+
|
|
865
|
+
```
|
|
866
|
+
ghostdock sandboxes containers protection <sandbox-id> <container> --protected <value> [flags]
|
|
867
|
+
```
|
|
868
|
+
|
|
869
|
+
| Argument | Description |
|
|
870
|
+
| --- | --- |
|
|
871
|
+
| `<sandbox-id>` | Sandbox name (e.g. quiet-harbor) or id, from sandboxes list or sandboxes create. Names are unique within the organization. Required. |
|
|
872
|
+
| `<container>` | Container, by name. Required. |
|
|
873
|
+
| `--org <string>` | Organization id or slug, from organizations list. Ids survive renames; slugs change when the organization is renamed. Defaults to GHOSTDOCK_ORG, then `organizations use`. |
|
|
874
|
+
| `--protected` | true: protect it; false: allow removing it. Required. |
|
|
875
|
+
|
|
876
|
+
MCP tool: `sandboxes_containers_protection`.
|
|
877
|
+
|
|
878
|
+
### `ghostdock sandboxes containers restart`
|
|
879
|
+
|
|
880
|
+
Restart a container, as docker restart does (stopping as docker stop does). Starts the sandbox when needed.
|
|
881
|
+
|
|
882
|
+
```
|
|
883
|
+
ghostdock sandboxes containers restart <sandbox-id> <container> [flags]
|
|
884
|
+
```
|
|
885
|
+
|
|
886
|
+
| Argument | Description |
|
|
887
|
+
| --- | --- |
|
|
888
|
+
| `<sandbox-id>` | Sandbox name (e.g. quiet-harbor) or id, from sandboxes list or sandboxes create. Names are unique within the organization. Required. |
|
|
889
|
+
| `<container>` | Container, by name. Required. |
|
|
890
|
+
| `--org <string>` | Organization id or slug, from organizations list. Ids survive renames; slugs change when the organization is renamed. Defaults to GHOSTDOCK_ORG, then `organizations use`. |
|
|
891
|
+
|
|
892
|
+
MCP tool: `sandboxes_containers_restart`.
|
|
893
|
+
|
|
894
|
+
### `ghostdock sandboxes containers start`
|
|
895
|
+
|
|
896
|
+
Start a stopped container, as docker start does. A running container stays as it is. Starts the sandbox when needed.
|
|
897
|
+
|
|
898
|
+
```
|
|
899
|
+
ghostdock sandboxes containers start <sandbox-id> <container> [flags]
|
|
900
|
+
```
|
|
901
|
+
|
|
902
|
+
| Argument | Description |
|
|
903
|
+
| --- | --- |
|
|
904
|
+
| `<sandbox-id>` | Sandbox name (e.g. quiet-harbor) or id, from sandboxes list or sandboxes create. Names are unique within the organization. Required. |
|
|
905
|
+
| `<container>` | Container, by name. Required. |
|
|
906
|
+
| `--org <string>` | Organization id or slug, from organizations list. Ids survive renames; slugs change when the organization is renamed. Defaults to GHOSTDOCK_ORG, then `organizations use`. |
|
|
907
|
+
|
|
908
|
+
MCP tool: `sandboxes_containers_start`.
|
|
909
|
+
|
|
910
|
+
### `ghostdock sandboxes containers stop`
|
|
911
|
+
|
|
912
|
+
Stop a container, as docker stop does. It gets its own stop signal, then a kill after its own stop timeout. It stays stopped while the sandbox sleeps and wakes, as Docker keeps a stopped container stopped, unless its restart policy is always. On a stopped sandbox it does nothing (note sandbox_stopped). The container main runs the sandbox: its stop is refused (main_is_the_sandbox), pause the sandbox instead. Deletion protection does not block it. note says when it was the default container or the last one running: then SSH, commands and files have nowhere to land until one runs.
|
|
913
|
+
|
|
914
|
+
```
|
|
915
|
+
ghostdock sandboxes containers stop <sandbox-id> <container> [flags]
|
|
916
|
+
```
|
|
917
|
+
|
|
918
|
+
| Argument | Description |
|
|
919
|
+
| --- | --- |
|
|
920
|
+
| `<sandbox-id>` | Sandbox name (e.g. quiet-harbor) or id, from sandboxes list or sandboxes create. Names are unique within the organization. Required. |
|
|
921
|
+
| `<container>` | Container, by name. Required. |
|
|
922
|
+
| `--org <string>` | Organization id or slug, from organizations list. Ids survive renames; slugs change when the organization is renamed. Defaults to GHOSTDOCK_ORG, then `organizations use`. |
|
|
923
|
+
|
|
924
|
+
MCP tool: `sandboxes_containers_stop`.
|
|
925
|
+
|
|
810
926
|
### `ghostdock sandboxes create`
|
|
811
927
|
|
|
812
928
|
Create a sandbox from a snapshot, OCI image, Dockerfile or Compose files. Inline content only: for a directory or ZIP (Dockerfile COPY/ADD, Compose build files) use `ghostdock sandboxes build`. Snapshots and catalog images can require environment entries, URL ports and MCP names (requiredEnvironment / requiredUrls / requiredMcps); a missing environment entry fails with its names (missingEnvironment), and removing a required URL or MCP fails with them (missingUrls / missingMcps). Returns once the sandbox is running, with `boot`: how long the sandbox (VM) and, when one was started, its container took to start, each in ms. Idle-stop and auto-delete apply (defaults 20 minutes / 14 days). Read the sandboxes skill (`ghostdock skills get sandboxes`) for sources, manifests, lifecycle and providers.
|
|
@@ -819,7 +935,7 @@ ghostdock sandboxes create --source <object> [flags]
|
|
|
819
935
|
| --- | --- |
|
|
820
936
|
| `--org <string>` | Organization id or slug, from organizations list. Ids survive renames; slugs change when the organization is renamed. Defaults to GHOSTDOCK_ORG, then `organizations use`. |
|
|
821
937
|
| `--display-name <string>` | Display name for the sandbox. Optional. |
|
|
822
|
-
| `--source <object>` | What the sandbox boots from. Required. "image" boots an org catalog row by id ({ id } from images list / images get — images add OCI bookmarks, images add-dockerfile, and images add-compose rows) or any OCI ref ({ ref }); "dockerfile" builds inline Dockerfile text only (ghostdock.* LABEL lines parsed for manifest; this tool has no build directory, so COPY/ADD of local files fails — use the CLI `ghostdock sandboxes build --kind dockerfile` with a directory or ZIP); "compose" boots Docker-in-Docker from the given inline files (must include docker-compose.yml/yaml or compose.yml/yaml; ghostdock.* service labels parsed for manifest). A Compose project that needs extra files is not accepted here — use `ghostdock sandboxes build --kind compose`. Image, dockerfile, and compose sources never appear in snapshots list. Published static sites use sites publish (CDN), not a snapshot. (JSON object) Required. |
|
|
938
|
+
| `--source <object>` | What the sandbox boots from. Required. "image" boots an org catalog row by id ({ id } from images list / images get — images add OCI bookmarks, images add-dockerfile, and images add-compose rows) or any OCI ref ({ ref }); "dockerfile" builds inline Dockerfile text only (ghostdock.* LABEL lines parsed for manifest; this tool has no build directory, so COPY/ADD of local files fails — use the CLI `ghostdock sandboxes build --kind dockerfile` with a directory or ZIP); "compose" boots Docker-in-Docker from the given inline files (must include docker-compose.yml/yaml or compose.yml/yaml; ghostdock.* service labels parsed for manifest). A Compose project that needs extra files is not accepted here — use `ghostdock sandboxes build --kind compose`. "compose" also takes a published Compose project instead of files ({ reference: "oci://…", override? }): it runs through include:, the override merged into it. Image, dockerfile, and compose sources never appear in snapshots list. Published static sites use sites publish (CDN), not a snapshot. (JSON object) Required. |
|
|
823
939
|
| `--resources <object>` | Compute sizing. For image/dockerfile/compose: layered on platform defaults when omitted. For snapshot: optional override applied via resize after create. (JSON object) |
|
|
824
940
|
| `--auto-stop-interval-minutes <number>` | Minutes of inactivity before the platform worker idle-stops the sandbox. -1 means always on. 0 is rejected. Omit for the platform default. Provider-native timers are optional backup. |
|
|
825
941
|
| `--auto-delete-interval-minutes <number>` | Minutes the sandbox stays stopped before the platform worker deletes the record. 0 deletes it when it stops. -1 keeps it until a person deletes it. Omit for the platform default. Provider-native timers are optional backup. |
|
|
@@ -831,6 +947,24 @@ ghostdock sandboxes create --source <object> [flags]
|
|
|
831
947
|
|
|
832
948
|
MCP tool: `sandboxes_create`.
|
|
833
949
|
|
|
950
|
+
### `ghostdock sandboxes default-container`
|
|
951
|
+
|
|
952
|
+
Show, set or clear the sandbox’s default container. SSH, the terminal, files, commands and MCP land there when no container is named. Without container or clear it only shows the setting.
|
|
953
|
+
|
|
954
|
+
```
|
|
955
|
+
ghostdock sandboxes default-container <sandbox-id> [flags]
|
|
956
|
+
```
|
|
957
|
+
|
|
958
|
+
| Argument | Description |
|
|
959
|
+
| --- | --- |
|
|
960
|
+
| `<sandbox-id>` | Sandbox name (e.g. quiet-harbor) or id, from sandboxes list or sandboxes create. Names are unique within the organization. Required. |
|
|
961
|
+
| `--org <string>` | Organization id or slug, from organizations list. Ids survive renames; slugs change when the organization is renamed. Defaults to GHOSTDOCK_ORG, then `organizations use`. |
|
|
962
|
+
| `--container <string>` | Container to make the default, by name. The running sandbox must have it. |
|
|
963
|
+
| `--clear` | Clear the default. |
|
|
964
|
+
| `--start` | Start the container first when it is not running, without asking. |
|
|
965
|
+
|
|
966
|
+
MCP tool: `sandboxes_default_container`.
|
|
967
|
+
|
|
834
968
|
### `ghostdock sandboxes delete`
|
|
835
969
|
|
|
836
970
|
Permanently delete a sandbox and its files.
|
|
@@ -936,7 +1070,9 @@ ghostdock sandboxes files list <sandbox-id> [flags]
|
|
|
936
1070
|
| --- | --- |
|
|
937
1071
|
| `<sandbox-id>` | Sandbox name (e.g. quiet-harbor) or id, from sandboxes list or sandboxes create. Names are unique within the organization. Required. |
|
|
938
1072
|
| `--org <string>` | Organization id or slug, from organizations list. Ids survive renames; slugs change when the organization is renamed. Defaults to GHOSTDOCK_ORG, then `organizations use`. |
|
|
1073
|
+
| `--container <string>` | Container to work in, by name, from sandboxes containers list. Default: the sandbox’s default container, else the one running container. With several running and no default the call fails and lists them. |
|
|
939
1074
|
| `--path <string>` | Directory to list. Absolute or relative to /. Defaults to /workspace. |
|
|
1075
|
+
| `--start` | Start the container first when it is not running, without asking. |
|
|
940
1076
|
|
|
941
1077
|
MCP tool: `sandboxes_files_list`.
|
|
942
1078
|
|
|
@@ -953,6 +1089,8 @@ ghostdock sandboxes files read <path> --sandbox-id <string> [flags]
|
|
|
953
1089
|
| `<path>` | File path. Absolute or relative to / (for example /workspace/src/App.vue). Required. |
|
|
954
1090
|
| `--org <string>` | Organization id or slug, from organizations list. Ids survive renames; slugs change when the organization is renamed. Defaults to GHOSTDOCK_ORG, then `organizations use`. |
|
|
955
1091
|
| `--sandbox-id <string>` | Sandbox name (e.g. quiet-harbor) or id, from sandboxes list or sandboxes create. Names are unique within the organization. Required. |
|
|
1092
|
+
| `--container <string>` | Container to work in, by name, from sandboxes containers list. Default: the sandbox’s default container, else the one running container. With several running and no default the call fails and lists them. |
|
|
1093
|
+
| `--start` | Start the container first when it is not running, without asking. |
|
|
956
1094
|
|
|
957
1095
|
MCP tool: `sandboxes_files_read`.
|
|
958
1096
|
|
|
@@ -1125,6 +1263,8 @@ ghostdock sandboxes shells close <session-id> --sandbox-id <string> [flags]
|
|
|
1125
1263
|
| `<session-id>` | Session id from sandboxes shells create. Required. |
|
|
1126
1264
|
| `--org <string>` | Organization id or slug, from organizations list. Ids survive renames; slugs change when the organization is renamed. Defaults to GHOSTDOCK_ORG, then `organizations use`. |
|
|
1127
1265
|
| `--sandbox-id <string>` | Sandbox name (e.g. quiet-harbor) or id, from sandboxes list or sandboxes create. Names are unique within the organization. Required. |
|
|
1266
|
+
| `--container <string>` | Container to work in, by name, from sandboxes containers list. Default: the sandbox’s default container, else the one running container. With several running and no default the call fails and lists them. |
|
|
1267
|
+
| `--start` | Start the container first when it is not running, without asking. |
|
|
1128
1268
|
|
|
1129
1269
|
MCP tool: `sandboxes_shells_close`.
|
|
1130
1270
|
|
|
@@ -1140,7 +1280,9 @@ ghostdock sandboxes shells create <sandbox-id> [flags]
|
|
|
1140
1280
|
| --- | --- |
|
|
1141
1281
|
| `<sandbox-id>` | Sandbox name (e.g. quiet-harbor) or id, from sandboxes list or sandboxes create. Names are unique within the organization. Required. |
|
|
1142
1282
|
| `--org <string>` | Organization id or slug, from organizations list. Ids survive renames; slugs change when the organization is renamed. Defaults to GHOSTDOCK_ORG, then `organizations use`. |
|
|
1283
|
+
| `--container <string>` | Container to work in, by name, from sandboxes containers list. Default: the sandbox’s default container, else the one running container. With several running and no default the call fails and lists them. |
|
|
1143
1284
|
| `--session-id <string>` | Id for the new session: a slug; user-cmd, image-cmd and compose are reserved. Omit to generate one. |
|
|
1285
|
+
| `--start` | Start the container first when it is not running, without asking. |
|
|
1144
1286
|
|
|
1145
1287
|
MCP tool: `sandboxes_shells_create`.
|
|
1146
1288
|
|
|
@@ -1160,6 +1302,8 @@ ghostdock sandboxes ssh get <sandbox-id> [flags]
|
|
|
1160
1302
|
| --- | --- |
|
|
1161
1303
|
| `<sandbox-id>` | Sandbox name (e.g. quiet-harbor) or id, from sandboxes list or sandboxes create. Names are unique within the organization. Required. |
|
|
1162
1304
|
| `--org <string>` | Organization id or slug, from organizations list. Ids survive renames; slugs change when the organization is renamed. Defaults to GHOSTDOCK_ORG, then `organizations use`. |
|
|
1305
|
+
| `--container <string>` | Container to work in, by name, from sandboxes containers list. Default: the sandbox’s default container, else the one running container. With several running and no default the call fails and lists them. |
|
|
1306
|
+
| `--start` | Start the container first when it is not running, without asking. |
|
|
1163
1307
|
|
|
1164
1308
|
MCP tool: `sandboxes_ssh_get`.
|
|
1165
1309
|
|
|
@@ -1208,6 +1352,40 @@ ghostdock sandboxes stop <sandbox-id> [flags]
|
|
|
1208
1352
|
|
|
1209
1353
|
MCP tool: `sandboxes_stop`.
|
|
1210
1354
|
|
|
1355
|
+
### `ghostdock sandboxes storage`
|
|
1356
|
+
|
|
1357
|
+
### `ghostdock sandboxes storage delete`
|
|
1358
|
+
|
|
1359
|
+
Delete a named volume or a top-level sandbox folder, with everything in it. Refused while a container mounts it (in any state: a stopped one counts, so stopping does not help), mounts a folder above it (a bind of /), or a volume keeps its data in the folder: remove those first.
|
|
1360
|
+
|
|
1361
|
+
```
|
|
1362
|
+
ghostdock sandboxes storage delete <sandbox-id> --kind <string> --name <string> [flags]
|
|
1363
|
+
```
|
|
1364
|
+
|
|
1365
|
+
| Argument | Description |
|
|
1366
|
+
| --- | --- |
|
|
1367
|
+
| `<sandbox-id>` | Sandbox name (e.g. quiet-harbor) or id, from sandboxes list or sandboxes create. Names are unique within the organization. Required. |
|
|
1368
|
+
| `--org <string>` | Organization id or slug, from organizations list. Ids survive renames; slugs change when the organization is renamed. Defaults to GHOSTDOCK_ORG, then `organizations use`. |
|
|
1369
|
+
| `--kind <string>` | volume or folder. Required. |
|
|
1370
|
+
| `--name <string>` | The volume’s name, or the folder’s path in the sandbox (/srv, not /srv/app). Required. |
|
|
1371
|
+
|
|
1372
|
+
MCP tool: `sandboxes_storage_delete`.
|
|
1373
|
+
|
|
1374
|
+
### `ghostdock sandboxes storage list`
|
|
1375
|
+
|
|
1376
|
+
List a sandbox’s volumes and sandbox folders. The sandbox folders are where bind mounts land. Each with its size and sizeState (measured; measuring: ask again in a few seconds; tooBig: too big to measure cheaply; outside: a volume bound outside the sandbox folders, not measured nor browsable) and the containers using it, plus every container’s mounts. truncated says entries were left out. A stopped sandbox lists none (it is not started for this).
|
|
1377
|
+
|
|
1378
|
+
```
|
|
1379
|
+
ghostdock sandboxes storage list <sandbox-id> [flags]
|
|
1380
|
+
```
|
|
1381
|
+
|
|
1382
|
+
| Argument | Description |
|
|
1383
|
+
| --- | --- |
|
|
1384
|
+
| `<sandbox-id>` | Sandbox name (e.g. quiet-harbor) or id, from sandboxes list or sandboxes create. Names are unique within the organization. Required. |
|
|
1385
|
+
| `--org <string>` | Organization id or slug, from organizations list. Ids survive renames; slugs change when the organization is renamed. Defaults to GHOSTDOCK_ORG, then `organizations use`. |
|
|
1386
|
+
|
|
1387
|
+
MCP tool: `sandboxes_storage_list`.
|
|
1388
|
+
|
|
1211
1389
|
### `ghostdock sandboxes tools`
|
|
1212
1390
|
|
|
1213
1391
|
Tools of the MCP servers inside a sandbox.
|
package/dist/cli.md
CHANGED
|
@@ -314,6 +314,25 @@ ghostdock sandboxes create --org org_123 --display-name "Marketing site"
|
|
|
314
314
|
ghostdock sandboxes urls create quiet-harbor --port 8080 --auto-wake true --public true
|
|
315
315
|
```
|
|
316
316
|
|
|
317
|
+
#### Containers in a sandbox
|
|
318
|
+
|
|
319
|
+
On Ghostdock Cloud a sandbox runs one Docker engine; everything in it is an ordinary container.
|
|
320
|
+
`ssh get`, `files`, `commands` and `shells` land in one of them: `--container <name>`, else the
|
|
321
|
+
sandbox's default container, else the one running container. With several running and no default,
|
|
322
|
+
the CLI asks which one at the keyboard and offers to make it the default; without a terminal it
|
|
323
|
+
fails and lists the names. A command runs as `docker exec` does there: as the container's
|
|
324
|
+
`ghostdock.login.user`, else the image's `USER`, else root.
|
|
325
|
+
|
|
326
|
+
```bash
|
|
327
|
+
ghostdock sandboxes containers list quiet-harbor
|
|
328
|
+
ghostdock sandboxes default-container quiet-harbor --container web # --clear true removes it
|
|
329
|
+
ghostdock sandboxes commands run quiet-harbor --container db --command 'pg_isready'
|
|
330
|
+
ghostdock sandboxes containers protection quiet-harbor workstation --protected false
|
|
331
|
+
```
|
|
332
|
+
|
|
333
|
+
A shell session lives in its container: pass the same `--container` to every `shells` and
|
|
334
|
+
`commands` call on it.
|
|
335
|
+
|
|
317
336
|
#### Environment in a sandbox
|
|
318
337
|
|
|
319
338
|
A sandbox exports **nothing** by default (unless you boot from an organization snapshot or catalog
|
|
@@ -612,12 +631,12 @@ or read [`cli-reference.md`](cli-reference.md) for every command's full descript
|
|
|
612
631
|
| Command | What it does |
|
|
613
632
|
| --- | --- |
|
|
614
633
|
| `ghostdock images add --ref <string> [flags]` | Bookmark an OCI image ref in the organization’s image catalog. |
|
|
615
|
-
| `ghostdock images add-compose --name <string>
|
|
634
|
+
| `ghostdock images add-compose --name <string> [flags]` | Add a Compose project to the organization’s image catalog. |
|
|
616
635
|
| `ghostdock images add-dockerfile --name <string> --dockerfile <string> [flags]` | Add a Dockerfile to the organization’s image catalog. |
|
|
617
636
|
| `ghostdock images get <image-id> [flags]` | Get one catalog image with its spec, manifest and requirements. |
|
|
618
637
|
| `ghostdock images list [flags]` | List the images an organization can boot sandboxes from. |
|
|
619
638
|
| `ghostdock images remove <image-id> [flags]` | Remove an image from the organization’s catalog. |
|
|
620
|
-
| `ghostdock images update-compose <image-id> [flags]` | Replace a catalog Compose image’s files and/or name. |
|
|
639
|
+
| `ghostdock images update-compose <image-id> [flags]` | Replace a catalog Compose image’s files, reference, override and/or name. |
|
|
621
640
|
| `ghostdock images update-dockerfile <image-id> --dockerfile <string> [flags]` | Replace a catalog Dockerfile, optionally renaming it. |
|
|
622
641
|
|
|
623
642
|
#### login
|
|
@@ -695,7 +714,14 @@ or read [`cli-reference.md`](cli-reference.md) for every command's full descript
|
|
|
695
714
|
| `ghostdock sandboxes commands kill <command-id> --sandbox-id <string> --session-id <string> [flags]` | Interrupt a running shell command. |
|
|
696
715
|
| `ghostdock sandboxes commands logs <command-id> --sandbox-id <string> --session-id <string> [flags]` | Get a page of a shell command’s stdout and stderr. |
|
|
697
716
|
| `ghostdock sandboxes commands run <sandbox-id> --command <string> [flags]` | Run a shell command in a sandbox. |
|
|
717
|
+
| `ghostdock sandboxes containers list <sandbox-id> [flags]` | List the containers of a sandbox, running or not. |
|
|
718
|
+
| `ghostdock sandboxes containers logs <sandbox-id> <container> [flags]` | Read a container’s output, as docker logs does. |
|
|
719
|
+
| `ghostdock sandboxes containers protection <sandbox-id> <container> --protected <value> [flags]` | Switch a container’s deletion protection on or off. |
|
|
720
|
+
| `ghostdock sandboxes containers restart <sandbox-id> <container> [flags]` | Restart a container, as docker restart does (stopping as docker stop does). |
|
|
721
|
+
| `ghostdock sandboxes containers start <sandbox-id> <container> [flags]` | Start a stopped container, as docker start does. |
|
|
722
|
+
| `ghostdock sandboxes containers stop <sandbox-id> <container> [flags]` | Stop a container, as docker stop does. |
|
|
698
723
|
| `ghostdock sandboxes create --source <object> [flags]` | Create a sandbox from a snapshot, OCI image, Dockerfile or Compose files. |
|
|
724
|
+
| `ghostdock sandboxes default-container <sandbox-id> [flags]` | Show, set or clear the sandbox’s default container. |
|
|
699
725
|
| `ghostdock sandboxes delete <sandbox-id> [flags]` | Permanently delete a sandbox and its files. |
|
|
700
726
|
| `ghostdock sandboxes env delete <name> --sandbox-id <string> [flags]` | Delete one of a sandbox’s own variables or secrets. |
|
|
701
727
|
| `ghostdock sandboxes env get <sandbox-id> [flags]` | Get a sandbox’s environment: selections, bindings and local entries. |
|
|
@@ -718,6 +744,8 @@ or read [`cli-reference.md`](cli-reference.md) for every command's full descript
|
|
|
718
744
|
| `ghostdock sandboxes ssh revoke <sandbox-id> [flags]` | Revoke a sandbox’s active SSH access. |
|
|
719
745
|
| `ghostdock sandboxes status <sandbox-id> [flags]` | Get a sandbox’s status and lifecycle deadlines without waking it. |
|
|
720
746
|
| `ghostdock sandboxes stop <sandbox-id> [flags]` | Stop a running sandbox without deleting its files. |
|
|
747
|
+
| `ghostdock sandboxes storage delete <sandbox-id> --kind <string> --name <string> [flags]` | Delete a named volume or a top-level sandbox folder, with everything in it. |
|
|
748
|
+
| `ghostdock sandboxes storage list <sandbox-id> [flags]` | List a sandbox’s volumes and sandbox folders. |
|
|
721
749
|
| `ghostdock sandboxes tools call <name> --sandbox-id <string> --arguments <object> [flags]` | Call a tool on an MCP server inside a sandbox. |
|
|
722
750
|
| `ghostdock sandboxes tools list <sandbox-id> [flags]` | List the tools of the MCP servers a sandbox exposes. |
|
|
723
751
|
| `ghostdock sandboxes update <sandbox-id> [flags]` | Change a sandbox’s display name, idle-stop or auto-delete interval. |
|