@aetherix-ops/ptero-cli
v1.0.0
Published
Command line tool for managing Pterodactyl Panel from your terminal
Downloads
33
Maintainers
Readme
@aetherix-ops/ptero-cli
Command line tool for managing Pterodactyl Panel from your terminal. Built on top of @aetherix-ops/ptero-api.
Installation
npm install -g @aetherix-ops/ptero-cliSetup
ptero config setupOr set environment variables:
export PTERO_URL=https://panel.yourdomain.com
export PTERO_CLIENT_KEY=your_client_api_key
export PTERO_APP_KEY=your_application_api_keyConfig is saved to ~/.ptero/config.json
Commands
Server
# List all servers
ptero server list
ptero server ls
# List with RAM/CPU stats
ptero server list --stats
# Get server status and resources
ptero server status <id>
# Power actions
ptero server start <id>
ptero server stop <id>
ptero server restart <id>
ptero server kill <id>
# Send console command
ptero server cmd <id> "say Hello!"
# Suspend / unsuspend (admin)
ptero server suspend <id>
ptero server unsuspend <id>User (Admin)
# List all users
ptero user list
# Get user details
ptero user info <id>
# Create user
ptero user create \
--email [email protected] \
--username newuser \
--firstname John \
--lastname Doe
# Delete user
ptero user delete <id>Node (Admin)
# List all nodes
ptero node list
# Get node details
ptero node info <id>Output Example
──────────────────────────────────────────────────
Servers
──────────────────────────────────────────────────
ID NAME NODE
abc12345 TelisSMP node-1
def67890 Lunexia Bot node-1
ghi11223 Dev API node-1
Total: 3 servers──────────────────────────────────────────────────
Servers (with --stats)
──────────────────────────────────────────────────
ID NAME STATUS RAM CPU DISK
abc12345 TelisSMP ● running 2.1GB 28.4% 8.2GB
def67890 Lunexia Bot ● running 512.0MB 12.1% 1.1GB
ghi11223 Dev API ○ offline - - -Related
- ptero-api — The API library powering this CLI
- ptero-scripts — Shell scripts for Pterodactyl
- ptero-eggs — Updated egg collection
License
MIT — by aetherix-ops
