Type at least two characters.

↑ ↓ moveEnter openEsc close
View .md

FeatherCli command reference

All 60 FeatherCli 1.1.3 commands (49 you can run, 11 groups) with their arguments, options and defaults, read from the FeatherPanel-CLI source.

Last synced from FeatherCli 10bcb7e on .

On this page

Generated from the System.CommandLine definitions in FeatherPanel-CLI (version 1.1.3, net10.0). Install and configure it first; see FeatherCli. Run feathercli <command> --help for the same information on your machine. Options without a default are optional unless marked required; most commands prompt for a missing server UUID.

Global options

  • --verbose: Enable verbose output
  • --help, -h, -?: help for any command (added by System.CommandLine).
  • --version, -v: print the version and exit. Program.cs checks for these before parsing, so they work with any command.

server

Manage game servers.

feathercli server list

List all serverssource
feathercli server list [options]
Argument or optionTypeDefaultDescription
--pageint1Page number for pagination
--limitint10Number of servers per page
--searchstring?-Search term to filter servers by name or description
--allbool-Show all servers (ignores pagination)

feathercli server start

Start a game serversource
feathercli server start [options]
Argument or optionTypeDefaultDescription
--uuidstring?-Server UUID or short UUID (will prompt if not provided)

feathercli server stop

Stop a game serversource
feathercli server stop [options]
Argument or optionTypeDefaultDescription
--uuidstring?-Server UUID or short UUID (will prompt if not provided)

feathercli server restart

Restart a game serversource
feathercli server restart [options]
Argument or optionTypeDefaultDescription
--uuidstring?-Server UUID or short UUID (will prompt if not provided)

feathercli server kill

Force kill a game serversource
feathercli server kill [options]
Argument or optionTypeDefaultDescription
--uuidstring?-Server UUID or short UUID (will prompt if not provided)

feathercli server logs

View server logssource
feathercli server logs [options]
Argument or optionTypeDefaultDescription
--uuidstring?-Server UUID or short UUID (will prompt if not provided)
--linesint50Number of lines to display (default: 50)
--uploadbool-Upload logs to mclo.gs and get shareable URL

feathercli server install-logs

View server installation logssource
feathercli server install-logs [options]
Argument or optionTypeDefaultDescription
--uuidstring?-Server UUID or short UUID (will prompt if not provided)
--uploadbool-Upload installation logs to mclo.gs and get shareable URL

feathercli server info

Get detailed information about a serversource
feathercli server info [options]
Argument or optionTypeDefaultDescription
--uuidstring?-Server UUID or short UUID (will prompt if not provided)

feathercli server command

Send a command to a serversource
feathercli server command [options]
Argument or optionTypeDefaultDescription
--uuidstring?-Server UUID or short UUID (will prompt if not provided)
--commandstring?-Command to send to the server (will prompt if not provided)

feathercli server reinstall

Reinstall a server (resets to initial state)source
feathercli server reinstall [options]
Argument or optionTypeDefaultDescription
--uuidstring?-Server UUID or short UUID (will prompt if not provided)
--forcebool-Skip confirmation prompt (use with caution)

feathercli server connect

Connect to server console via Wings WebSocket for real-time accesssource
feathercli server connect [options]
Argument or optionTypeDefaultDescription
--uuidstring?-Server UUID or short UUID (will prompt if not provided)

feathercli server backupsgroup

Manage server backupssource
feathercli server backups <command>

feathercli server backups list

List backupssource
feathercli server backups list [options]
Argument or optionTypeDefaultDescription
--uuidstring?-Server UUID or short UUID

feathercli server backups create

Create a backupsource
feathercli server backups create [options]
Argument or optionTypeDefaultDescription
--uuidstring?-Server UUID or short UUID
--namestring?-Backup name

feathercli server backups delete

Delete a backupsource
feathercli server backups delete [options]
Argument or optionTypeDefaultDescription
--uuidstring?-Server UUID or short UUID
--backuprequiredstring-Backup UUID
--forceboolfalseSkip confirmation

feathercli server backups restore

Restore a backupsource
feathercli server backups restore [options]
Argument or optionTypeDefaultDescription
--uuidstring?-Server UUID or short UUID
--backuprequiredstring-Backup UUID
--truncateboolfalseWipe files before restore
--forceboolfalseSkip confirmation

feathercli server backups download

Get backup download URLsource
feathercli server backups download [options]
Argument or optionTypeDefaultDescription
--uuidstring?-Server UUID or short UUID
--backuprequiredstring-Backup UUID

feathercli server backups lock

Lock a backupsource
feathercli server backups lock [options]
Argument or optionTypeDefaultDescription
--uuidstring?-Server UUID or short UUID
--backuprequiredstring-Backup UUID

feathercli server backups unlock

Unlock a backupsource
feathercli server backups unlock [options]
Argument or optionTypeDefaultDescription
--uuidstring?-Server UUID or short UUID
--backuprequiredstring-Backup UUID

feathercli server filesgroup

Manage server filessource
feathercli server files <command>

feathercli server files list

List files in a directorysource
feathercli server files list [options]
Argument or optionTypeDefaultDescription
--uuidstring?-Server UUID or short UUID
--pathstring/Directory path

feathercli server files read

Read a filesource
feathercli server files read [options]
Argument or optionTypeDefaultDescription
--uuidstring?-Server UUID or short UUID
--pathrequiredstring-Remote file path
--outstring?-Write to local file instead of stdout

feathercli server files write

Write a local file to the serversource
feathercli server files write [options]
Argument or optionTypeDefaultDescription
--uuidstring?-Server UUID or short UUID
--pathrequiredstring-Remote file path
--filerequiredstring-Local file to upload

feathercli server files delete

Delete files or directoriessource
feathercli server files delete [options]
Argument or optionTypeDefaultDescription
--uuidstring?-Server UUID or short UUID
--pathrequiredstring[]-Paths to delete
--rootstring/Root directory
--forceboolfalseSkip confirmation

feathercli server files mkdir

Create a directorysource
feathercli server files mkdir [options]
Argument or optionTypeDefaultDescription
--uuidstring?-Server UUID or short UUID
--pathrequiredstring-Parent directory
--namerequiredstring-Directory name

feathercli server databasesgroup

Manage server databasessource
feathercli server databases <command>

feathercli server databases list

List databasessource
feathercli server databases list [options]
Argument or optionTypeDefaultDescription
--uuidstring?-Server UUID or short UUID

feathercli server databases hosts

List available database hostssource
feathercli server databases hosts [options]
Argument or optionTypeDefaultDescription
--uuidstring?-Server UUID or short UUID

feathercli server databases create

Create a databasesource
feathercli server databases create [options]
Argument or optionTypeDefaultDescription
--uuidstring?-Server UUID or short UUID
--host-idrequiredint-Database host ID
--namerequiredstring-Database name
--remotestring?-Remote access pattern (default %)

feathercli server databases delete

Delete a databasesource
feathercli server databases delete [options]
Argument or optionTypeDefaultDescription
--uuidstring?-Server UUID or short UUID
--idrequiredint-Database ID
--forceboolfalseSkip confirmation

feathercli server schedulesgroup

Manage server schedulessource
feathercli server schedules <command>

feathercli server schedules list

List schedulessource
feathercli server schedules list [options]
Argument or optionTypeDefaultDescription
--uuidstring?-Server UUID or short UUID

feathercli server schedules create

Create a schedulesource
feathercli server schedules create [options]
Argument or optionTypeDefaultDescription
--uuidstring?-Server UUID or short UUID
--namerequiredstring-Schedule name
--minutestring0Cron minute
--hourstring*Cron hour
--day-of-monthstring*Cron day of month
--monthstring*Cron month
--day-of-weekstring*Cron day of week
--timezonestring?-IANA timezone

feathercli server schedules delete

Delete a schedulesource
feathercli server schedules delete [options]
Argument or optionTypeDefaultDescription
--uuidstring?-Server UUID or short UUID
--idrequiredint-Schedule ID
--forceboolfalseSkip confirmation

feathercli server schedules run

Run a schedule nowsource
feathercli server schedules run [options]
Argument or optionTypeDefaultDescription
--uuidstring?-Server UUID or short UUID
--idrequiredint-Schedule ID

feathercli server schedules toggle

Enable/disable a schedulesource
feathercli server schedules toggle [options]
Argument or optionTypeDefaultDescription
--uuidstring?-Server UUID or short UUID
--idrequiredint-Schedule ID

account

Account, SSH keys, and notifications.

feathercli account me

Show the current user sessionsource
feathercli account me

feathercli account ssh-keysgroup

Manage SSH keyssource
feathercli account ssh-keys <command>

feathercli account ssh-keys list

List SSH keyssource
feathercli account ssh-keys list

feathercli account ssh-keys add

Add an SSH keysource
feathercli account ssh-keys add [options]
Argument or optionTypeDefaultDescription
--namerequiredstring-Key name
--keystring?-Public key contents
--filestring?-Path to public key file

feathercli account ssh-keys delete

Delete an SSH keysource
feathercli account ssh-keys delete [options]
Argument or optionTypeDefaultDescription
--idrequiredint-SSH key ID
--forceboolfalseSkip confirmation

feathercli account notificationsgroup

Manage notificationssource
feathercli account notifications <command>

feathercli account notifications list

List notificationssource
feathercli account notifications list

feathercli account notifications dismiss

Dismiss a notificationsource
feathercli account notifications dismiss [options]
Argument or optionTypeDefaultDescription
--idrequiredint-Notification ID

config

Manage CLI configuration.

feathercli config setup

Setup FeatherCli configurationsource
feathercli config setup

feathercli config show

Show current configurationsource
feathercli config show

feathercli config set

Set a configuration valuesource
feathercli config set <key> <value>
Argument or optionTypeDefaultDescription
<key>string-Configuration key (api_url, api_key)
<value>string-Configuration value

feathercli config test

Test API connectionsource
feathercli config test

migrate

Migrate from Pterodactyl to FeatherPanel.

feathercli migrate check

Check if Pterodactyl installation is ready for migration (without migrating)source
feathercli migrate check [options]
Argument or optionTypeDefaultDescription
--pterodactyl-dirstring?nullPath to Pterodactyl installation directory (skips the prompt)

oauth2

OAuth2 API Consent: Documentation + Playground.

feathercli oauth2 docs

Display OAuth2 API Consent documentationsource
feathercli oauth2 docs

feathercli oauth2 playground

Interactive OAuth2 playgroundsource
feathercli oauth2 playground [options]
Argument or optionTypeDefaultDescription
--name, -nstring?-API key/client name that will be created on approval
--callback, -cstring?-Absolute callback URL (supports https://, http://localhost, and custom schemes)
--app-namestring?-Display name of requesting app
--app-logostring?-Absolute URL of app logo
--description, -dstring?-Consent description text shown to user
--mode, -mstringuseruser (default) for browser redirect, or server for server-to-server callback
--allowed-ipsstring?-Comma/newline separated IPv4/IPv6/CIDR restrictions
--alert-corsboolfalseEnable foreign IP blocked-attempt notifications

feathercli oauth2 validate

Validate OAuth2 credentialssource
feathercli oauth2 validate [options]
Argument or optionTypeDefaultDescription
--public-key, -pstring-Public key to validate (required)

feathercli oauth2 exchange

Exchange authorization code for credentialssource
feathercli oauth2 exchange [options]
Argument or optionTypeDefaultDescription
--code, -cstring-Authorization code to exchange (required)

version

Show version information.

feathercli version

Show version informationsource
feathercli version
Written from the source:FeatherPanel-CLI/Core/Commands/CommandRegistry.csFeatherPanel-CLI/Program.csFeatherPanel-CLI/Commands
View source on GitHubReport a problemLast updated