alpacon
CLI Guide
Alpacon websh

alpacon websh

Open a Websh terminal or execute a command on a server

Synopsis

This command either opens a Websh terminal session for the specified server
or executes a given command directly and displays the result.

Websh provides a remote terminal interface for managing servers,
with support for direct command execution, environment variables, and session sharing.

alpacon websh [SERVER_NAME] [COMMAND] [flags]

Examples

# Open an interactive Websh terminal for a server
alpacon websh [SERVER_NAME]
 
# Execute a command directly on the server and view the output
alpacon websh [SERVER_NAME] [COMMAND]
 
# Set environment variables for the command
alpacon websh --env="KEY1=VALUE1" --env="KEY2=VALUE2" [SERVER_NAME] [COMMAND]
 
# Use the value of an existing shell environment variable
alpacon websh --env="KEY" [SERVER_NAME] [COMMAND]
 
# Run Websh as root user
alpacon websh -r [SERVER_NAME]
alpacon websh -u root [SERVER_NAME]
 
# Run Websh specifying username and groupname
alpacon websh -u [USERNAME] -g [GROUPNAME] [SERVER_NAME]
 
# Run a command as a specific user/group
alpacon websh -u [USERNAME] -g [GROUPNAME] [SERVER_NAME] [COMMAND]
 
# Share the current terminal via temporary link
alpacon websh [SERVER_NAME] --share
alpacon websh [SERVER_NAME] --share --read-only true
 
# Join an existing shared Websh session
alpacon websh join --url [SHARE_URL] --password [PASSWORD]

Flags

FlagDescription
-rRun Websh as the root user
-u, --username [USERNAME]Specify the username to run the command
-g, --groupname [GROUPNAME]Specify the group to run the command
--env="KEY=VALUE"Set environment variable for the command
--env="KEY"Use current shell value for the environment variable
-s, --shareShare the terminal via a temporary link
--url [SHARE_URL]URL of the shared session (for joining)
-p, --password [PASSWORD]Password to access the shared session
--read-only [true/false]Set session to read-only mode (default: false)

⚠️ Note:

  • All flags must be placed before [SERVER_NAME].
  • -u, --username and -g, --groupname require a valid user or group name.

Options

  -h, --help   Show help for the websh command
Alpacon versionAlpacon log