-
-
Notifications
You must be signed in to change notification settings - Fork 1k
Command line usage
ZHAO Xudong edited this page Jan 11, 2025
·
12 revisions
Usage: electerm [options] sshServer
### Connect ssh server from command line examples:
- electerm user@xx.com
- electerm user@xx.com:22
- electerm --password password --set-env "SECRET=xxx USER=hhhh" user@xx.com:22
- electerm -l user -P 22 -i /path/to/private-key -pw password xx.com -T -t "XX
Server"
### Other params examples:
- server port:
electerm -sp 30976
- load and run batch operation from csv file:
electerm -bo "/home/root/works.csv"
### other connection types
- telnet: electerm -tp "telnet" -opts '{"host":"192.168.1.1","port":21","username":"root","password":"123456"}'
- rdp: electerm -tp "rdp" -opts '{"host":"192.168.1.1","port":3389","username":"root","password":"123456"}'
- vnc: electerm -tp "vnc" -opts '{"host":"192.168.1.1","port":3389","username":"root","password":"123456"}'
- serial: electerm -tp "serial" -opts '{"port":"COM1","baudRate":115200,"dataBits":8,"stopBits":1,"parity":"none"}'
- local: electerm -tp "local" -opts '{"title": "local terminal"}'
Options:
-V, --version output the version number
-t, --title [Tab Name] Specify the title of the new tab
-nw, --new-window Open this connection using standalone window
-l, --user <user> specify a login name
-P, --port <port> specify ssh port
-bo, --batch-op <batchOpFile> load and run batch operation from csv file
-sp, --server-port <serverPort> specify server port, default is
-i, --private-key-path <path> specify an SSH private key path
-ps, --passphrase <passphrase> specify an SSH private key passphrase
-pw, --password <password> specify ssh server password
-se, --set-env <setEnv> specify envs
-so, --sftp-only <sftpOnly> only show sftp panel
-d, --init-folder <initFolder> init folder got init terminal
-h, --help display help for commandElecterm supports the following proxy-related environment variables:
When set, this variable tells Electerm not to use a proxy server and to connect directly to the network.
Example:
ELECTRON_NO_PROXY_SERVER=1 npm startA comma-separated list of hostnames that should bypass the proxy server.
Example:
ELECTRON_PROXY_BYPASS_LIST="localhost,127.0.0.1" electermThe URL of a Proxy Auto-Configuration (PAC) file.
Example:
ELECTRON_PROXY_PAC_URL="http://example.com/proxy.pac" electermThe URL of the proxy server to use.
Example:
ELECTRON_PROXY_SERVER="http://proxy.example.com:8080" electermThis variable allows you to specify a custom path for the Electerm database.
Example:
DB_PATH="/path/to/custom/database" electermBy default, if DB_PATH is not set, Electerm will use its default database location.
You can use multiple environment variables together:
ELECTRON_PROXY_SERVER="http://proxy.example.com:8080" DB_PATH="/path/to/custom/database" electermThis command starts Electerm with a custom proxy server and a custom database path.