Skip to content

Commit 16feaa8

Browse files
committed
docs: update README to reflect changes in VNC command to console command
1 parent 88b9cbe commit 16feaa8

File tree

1 file changed

+8
-25
lines changed

1 file changed

+8
-25
lines changed

README.md

Lines changed: 8 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -844,16 +844,16 @@ The recovery-status command supports custom output formats with the following fi
844844
* status - Current recovery mode status
845845
846846
847-
### VNC Access
847+
### VNC/Console Access
848848
849-
The VNC command allows you to access your instance through a browser-based VNC console.
849+
The console command allows you to access your instance through a browser-based VNC console.
850850
851851
```sh
852852
# Open VNC console (default duration)
853-
civo instance vnc INSTANCE_ID/HOSTNAME
853+
civo instance console INSTANCE_ID/HOSTNAME
854854
855855
# Open VNC console with custom duration
856-
civo instance vnc INSTANCE_ID/HOSTNAME --duration 2h
856+
civo instance console INSTANCE_ID/HOSTNAME --duration 2h
857857
```
858858
859859
The `--duration` flag accepts Go's duration format:
@@ -868,18 +868,13 @@ When executed, the command will:
868868
4. Attempt to connect for up to 35 seconds before timing out
869869
870870
```sh
871-
# Check the status of a VNC session
872-
civo instance vnc-status INSTANCE_ID/HOSTNAME
871+
# Check the status of a VNC/console session
872+
civo instance console status INSTANCE_ID/HOSTNAME
873873

874-
# Stop an active VNC session
875-
civo instance vnc-stop INSTANCE_ID/HOSTNAME
874+
# Stop an active VNC/console session
875+
civo instance console stop INSTANCE_ID/HOSTNAME
876876
```
877877
878-
The `vnc-status` command will return the current state of the VNC session, including its URI and expiration time. If no session is active, it will notify you.
879-
880-
The `vnc-stop` command will terminate any active VNC session for the instance. If no session is active, it will confirm that there was nothing to stop.
881-
882-
883878
## Kubernetes clusters
884879
885880
#### Introduction
@@ -2448,15 +2443,3 @@ The code is available as open source under the terms of the [Apache License 2.0]
24482443
<a href = "https://github.com/civo/cli/graphs/contributors">
24492444
<img src = "https://contrib.rocks/image?repo=civo/cli"/>
24502445
</a>
2451-
2452-
# Get the status of the console for an instance
2453-
civo instance console status INSTANCE_ID/HOSTNAME
2454-
2455-
# Stop the console session for an instance
2456-
civo instance console stop INSTANCE_ID/HOSTNAME
2457-
2458-
# Open console (default duration)
2459-
civo instance console INSTANCE_ID/HOSTNAME
2460-
2461-
# Open console with custom duration
2462-
civo instance console INSTANCE_ID/HOSTNAME --duration 2h

0 commit comments

Comments
 (0)