Skip to content

Host command reference

Find local and cloud commands and their installed help.

Before you start

Run these commands on the host. Add --help as shown to see the options in your installed version. Availability can vary with the host, RustSC version and server.

With more than one server, commands that ask for a server need its name. The files and plugin library commands need a cloud connection and API key. Some host settings need administrator rights.

Status

  • `rustsc status`: Show the host service, cloud connection and server status.
rustsc status --help

Another account's folders

  • `rustsc allow-account`: Let RustSC set up servers in the folders of another account on this host.
rustsc allow-account --help

Servers

  • `rustsc server`: List the servers this host manages, show one or its measurements, lift a crash recovery hold, or inspect and repair game files.
  • `rustsc server list`: List the managed servers with their process state.
  • `rustsc server show`: Show one server: process, desired state, crash recovery and its newest action.
  • `rustsc server clear-hold`: Lift a crash recovery hold without starting the server.
  • `rustsc server same-start`: Show whether the next restart will start the server the way it runs now.
  • `rustsc server recovery`: Read or change automatic crash recovery on this host.
  • `rustsc server helper`: Programs this host starts around a server's start.
  • `rustsc server previous-save`: See or answer the request to use the previous save after the game found its save damaged.
  • `rustsc server inspect`: Check game files for problems.
  • `rustsc server repair`: Check every game file and replace the ones that differ from the original.
  • `rustsc server change-branch`: Move the server to another Steam branch, for example staging, or back to public.
  • `rustsc server update-game`: Update the game to the newest build of the branch the server is on.
  • `rustsc server check-game-update`: Check whether a newer build of the game is out for the branch the server is on.
  • `rustsc server metrics`: Show the server's latest measurements.
  • `rustsc server recovery show`: Show the automatic recovery setting.
  • `rustsc server recovery set`: Change the automatic recovery setting.
  • `rustsc server helper list`: List the server's helpers and what happened the last times they started.
  • `rustsc server helper add`: Add a helper, or replace the one with the same name.
  • `rustsc server helper remove`: Remove a helper.
  • `rustsc server previous-save show`: Show what is wrong with the save and which save would be used.
  • `rustsc server previous-save use`: Use the previous save and start the server.
  • `rustsc server previous-save decline`: Leave the server stopped.
rustsc server --help
rustsc server list --help
rustsc server show --help
rustsc server clear-hold --help
rustsc server same-start --help
rustsc server recovery --help
rustsc server helper --help
rustsc server previous-save --help
rustsc server inspect --help
rustsc server repair --help
rustsc server change-branch --help
rustsc server update-game --help
rustsc server check-game-update --help
rustsc server metrics --help
rustsc server recovery show --help
rustsc server recovery set --help
rustsc server helper list --help
rustsc server helper add --help
rustsc server helper remove --help
rustsc server previous-save show --help
rustsc server previous-save use --help
rustsc server previous-save decline --help

Start

  • `rustsc start`: Start a server and wait until it is ready.
rustsc start --help

Stop

  • `rustsc stop`: Save the world, then stop a server.
rustsc stop --help

Restart

  • `rustsc restart`: Save the world, stop a server, start it again and wait until it is ready.
rustsc restart --help

End a game

  • `rustsc kill`: End a server's game at once.
rustsc kill --help

Cancel a countdown

  • `rustsc cancel-countdown`: Cancel a pending stop or restart countdown.
rustsc cancel-countdown --help

Host

Operating system update controls are for Windows and require administrator rights.

  • `rustsc host`: Control the host itself.
  • `rustsc host restart`: Restart the host's operating system: warn players on every server, save and stop them, reboot, and start them again after the boot.
  • `rustsc host os-updates`: Show or change how this host handles operating system updates (Windows).
  • `rustsc host os-updates status`: Show the choice, what happens next and the last result.
  • `rustsc host os-updates set`: Change the choice on this host: off, on a schedule, or after the updates become available.
  • `rustsc host os-updates run-now`: Install the waiting updates now and restart the host only if they need it.
rustsc host --help
rustsc host restart --help
rustsc host os-updates --help
rustsc host os-updates status --help
rustsc host os-updates set --help
rustsc host os-updates run-now --help

Actions

  • `rustsc ops`: Show, follow, cancel or resolve local actions.
  • `rustsc ops list`: List recent actions.
  • `rustsc ops show`: Show one action and its result.
  • `rustsc ops watch`: Follow an action until it finishes.
  • `rustsc ops cancel`: Ask to cancel an action.
  • `rustsc ops stop-waiting`: Stop waiting when an action's result cannot be confirmed.
  • `rustsc ops resolve`: Record an action's outcome.
rustsc ops --help
rustsc ops list --help
rustsc ops show --help
rustsc ops watch --help
rustsc ops cancel --help
rustsc ops stop-waiting --help
rustsc ops resolve --help

Schedules

  • `rustsc schedule`: Show and manage the recurring restarts this host runs, also while the cloud is unreachable.
  • `rustsc schedule list`: List schedules.
  • `rustsc schedule show`: Show a schedule with its next and its last occurrence.
  • `rustsc schedule occurrences`: List the decided occurrences of a schedule, newest first.
  • `rustsc schedule add`: Add a recurring restart, local backup or wipe that this host runs, also while the cloud is unreachable.
  • `rustsc schedule enable`: Enable a schedule approved on this host.
  • `rustsc schedule disable`: Disable a schedule approved on this host.
  • `rustsc schedule remove`: Remove a schedule approved on this host.
rustsc schedule --help
rustsc schedule list --help
rustsc schedule show --help
rustsc schedule occurrences --help
rustsc schedule add --help
rustsc schedule enable --help
rustsc schedule disable --help
rustsc schedule remove --help

Temporary changes

  • `rustsc timed-change`: Temporary changes: files put in place for a while and the originals put back.
  • `rustsc timed-change list`: List the temporary changes this host holds, with what each is doing now.
  • `rustsc timed-change show`: Show one temporary change: its state, its next start and its latest runs.
  • `rustsc timed-change start`: Start a temporary change now: put its saved files in place.
  • `rustsc timed-change end`: End a temporary change now: put the original files back.
  • `rustsc timed-change extend`: Move the end of a temporary change that is on later, for example: rustsc timed-change extend "PvP purge" 4h.
  • `rustsc timed-change pause`: Pause a temporary change on this host: its starts are skipped until you resume it here.
  • `rustsc timed-change resume`: Resume a temporary change on this host.
  • `rustsc timed-change run-again`: Run a finished temporary change again.
rustsc timed-change --help
rustsc timed-change list --help
rustsc timed-change show --help
rustsc timed-change start --help
rustsc timed-change end --help
rustsc timed-change extend --help
rustsc timed-change pause --help
rustsc timed-change resume --help
rustsc timed-change run-again --help

Backups

  • `rustsc backup`: List, create, restore or clean up local backups, and choose how many to keep.
  • `rustsc backup policy`: Back up before every game launch (needs a backup folder).
  • `rustsc backup list`: List the backups stored on this host for a server, newest first.
  • `rustsc backup create`: Back up a server now: a running server saves its world first and keeps running.
  • `rustsc backup restore`: Preview, then restore a server from one of its backups.
  • `rustsc backup keep`: Show how many backups a server keeps, or change it.
  • `rustsc backup space`: Show or change what backups do about disk space: make room when the disk is nearly full, and an optional limit on the space they use.
  • `rustsc backup clean-up`: Remove logs unchanged for a week from a server's folder.
  • `rustsc backup delete`: Delete one backup of a server.
  • `rustsc backup check`: Read every stored backup of a server and say whether it is intact, damaged or gone.
  • `rustsc backup export`: Copy a backup's files into a new folder, each one checked.
  • `rustsc backup files`: List the files of a backup: each file's path, size, whether it was kept, left out or could not be copied, and why.
  • `rustsc backup policy show`: Show the backup settings now in use.
  • `rustsc backup policy set`: Change the backup settings.
rustsc backup --help
rustsc backup policy --help
rustsc backup list --help
rustsc backup create --help
rustsc backup restore --help
rustsc backup keep --help
rustsc backup space --help
rustsc backup clean-up --help
rustsc backup delete --help
rustsc backup check --help
rustsc backup export --help
rustsc backup files --help
rustsc backup policy show --help
rustsc backup policy set --help

Backup recovery keys

  • `rustsc custody`: Manage local repository credentials and independent recovery files.
  • `rustsc custody status`: Read credential status without revealing its value.
  • `rustsc custody provision`: Provision one protected local repository key.
  • `rustsc custody revoke`: Revoke one repository key.
  • `rustsc custody export`: Export one encrypted recovery bundle and generate its independent key file.
  • `rustsc custody import`: Recover one repository key from its encrypted bundle and separate key file.
rustsc custody --help
rustsc custody status --help
rustsc custody provision --help
rustsc custody revoke --help
rustsc custody export --help
rustsc custody import --help

Steam key

  • `rustsc steam-key`: Your own Steam Web API key on this host.
  • `rustsc steam-key status`: Say whether a Steam key is set on this host.
  • `rustsc steam-key set`: Save your Steam key on this host.
  • `rustsc steam-key clear`: Forget the Steam key on this host.
rustsc steam-key --help
rustsc steam-key status --help
rustsc steam-key set --help
rustsc steam-key clear --help

Framework

  • `rustsc framework`: Manage the server framework through the local host service.
  • `rustsc framework status`: Show the installed framework and available releases.
  • `rustsc framework preview`: Preview a framework change without downloading or changing files.
  • `rustsc framework change`: Apply a reviewed framework change.
rustsc framework --help
rustsc framework status --help
rustsc framework preview --help
rustsc framework change --help

Ports

  • `rustsc endpoints`: Read, save and explicitly apply server ports.
  • `rustsc endpoints status`: Show the saved ports.
  • `rustsc endpoints refresh`: Re-read the server's ports.
  • `rustsc endpoints save`: Save ports without applying them.
  • `rustsc endpoints apply`: Apply saved ports while stopped, or with an explicit warned restart.
  • `rustsc endpoints firewall-open`: Add the Windows Firewall rule for this server's game and query ports (and Rust+ while it has a port).
  • `rustsc endpoints firewall-remove`: Remove the Windows Firewall rule RustSC added for this server.
rustsc endpoints --help
rustsc endpoints status --help
rustsc endpoints refresh --help
rustsc endpoints save --help
rustsc endpoints apply --help
rustsc endpoints firewall-open --help
rustsc endpoints firewall-remove --help

Alerts

  • `rustsc alerts`: Show the resource alerts this host holds open now: low disk space and, when switched on, high CPU, memory or disk use.
  • `rustsc alerts acknowledge`: Acknowledge an alert, with an optional comment.
  • `rustsc alerts unacknowledge`: Clear the acknowledgement of an alert, so it shows as not acknowledged again.
rustsc alerts --help
rustsc alerts acknowledge --help
rustsc alerts unacknowledge --help

Console

  • `rustsc console`: Open a server's live console: read what it prints, type commands, and search or filter it.
rustsc console --help

Players

  • `rustsc players`: List the players on the server now.
rustsc players --help

Bans

  • `rustsc bans`: List the players banned from the server, newest first.
  • `rustsc bans export`: Write the server's ban list as a file: a CSV (the default) or the game's own bans.cfg lines.
  • `rustsc bans import`: Ban the players in a file or pasted list: one Steam ID per line with an optional reason, or a file from bans export.
rustsc bans --help
rustsc bans export --help
rustsc bans import --help

Kick

  • `rustsc kick`: Remove a player from the server now.
rustsc kick --help

Ban

  • `rustsc ban`: Ban a player by Steam ID.
rustsc ban --help

Unban

  • `rustsc unban`: Let a banned player join the server again.
rustsc unban --help

Wipe

  • `rustsc wipe`: Wipe the server.
rustsc wipe --help

Files

These commands need a cloud connection and an API key.

  • `rustsc files`: List, read, upload and change the files of a server's Oxide or Carbon folder through the RustSC cloud.
  • `rustsc files ls`: List a folder, for example oxide/plugins.
  • `rustsc files cat`: Print a text file.
  • `rustsc files upload`: Upload files or folders into a folder of the server.
  • `rustsc files rm`: Delete files or folders.
  • `rustsc files mv`: Move a file or folder to a new path, for example oxide/data/Pack/Kits.json.
  • `rustsc files cp`: Copy a file or folder to another place.
  • `rustsc files rename`: Give a file or folder a new name in the same folder.
  • `rustsc files new-file`: Make an empty file.
  • `rustsc files new-folder`: Make a folder.
  • `rustsc files restore`: Put a kept copy (name.kept-date-time) back under its own name.
rustsc files --help
rustsc files ls --help
rustsc files cat --help
rustsc files upload --help
rustsc files rm --help
rustsc files mv --help
rustsc files cp --help
rustsc files rename --help
rustsc files new-file --help
rustsc files new-folder --help
rustsc files restore --help

Plugin library

These commands need a cloud connection and an API key.

  • `rustsc plugin-library`: The plugin library of a server's temporary changes through the RustSC cloud: list it, add plugin files, go back to the previous version, look in the inbox, and turn the automatic update and hot swap on or off.
  • `rustsc plugin-library ls`: List every plugin the server's temporary changes turn on, with its version, what is waiting in the inbox and the automatic update choices.
  • `rustsc plugin-library add`: Add plugin files to the library.
  • `rustsc plugin-library back`: Put the previous version of a library plugin back.
  • `rustsc plugin-library check`: Look in the plugin inbox folder (data/plugin-inbox) for plugin files, for example ones put there with Windows Explorer or SFTP.
  • `rustsc plugin-library auto`: Turn the automatic update on or off: the library takes a newer version found in the plugins folder or the inbox by itself.
  • `rustsc plugin-library hot-swap`: Turn the separate hot swap choice on or off: with it on, a plugin a running temporary change has on can be swapped and reloaded from the portal.
  • `rustsc plugin-library self-healing`: Turn on or off putting the previous version back when an update RustSC applied fails to load.
  • `rustsc plugin-library source`: Set or take away a plugin's GitHub update source: a repository, a releases page or a link to the plugin's .cs file.
  • `rustsc plugin-library check-sources`: Look at the plugins' GitHub update sources and say which have a newer version.
  • `rustsc plugin-library update-from-source`: Take the newer version of the named plugins from their GitHub update sources into the library.
  • `rustsc plugin-library timing`: Choose when an automatic update is applied: after the next wipe (the default with the automatic switch) or at once.
rustsc plugin-library --help
rustsc plugin-library ls --help
rustsc plugin-library add --help
rustsc plugin-library back --help
rustsc plugin-library check --help
rustsc plugin-library auto --help
rustsc plugin-library hot-swap --help
rustsc plugin-library self-healing --help
rustsc plugin-library source --help
rustsc plugin-library check-sources --help
rustsc plugin-library update-from-source --help
rustsc plugin-library timing --help

RustSC updates

  • `rustsc update`: Check and install RustSC updates.
  • `rustsc update check`: Check for a new host version.
  • `rustsc update apply`: Install the newest version.
  • `rustsc update status`: Show how the latest update went.
  • `rustsc update policy`: Show or set the update policy.
rustsc update --help
rustsc update check --help
rustsc update apply --help
rustsc update status --help
rustsc update policy --help

Connect a host

  • `rustsc enroll`: Connect this host to a workspace.
rustsc enroll --help

Disconnect a host

  • `rustsc unenroll`: Disconnect this host from its workspace.
rustsc unenroll --help

Logs

  • `rustsc logs`: Show the latest lines of the RustSC logs on this host.
rustsc logs --help

Support file

  • `rustsc diagnostics`: Create a support file.
  • `sudo rustsc diagnostics bundle`: Save one zip file for support.
rustsc diagnostics --help
rustsc diagnostics bundle --help

Your local account

  • `rustsc whoami`: Show the OS user the host service sees for this command.
rustsc whoami --help

Analytics settings

Analytics are off.

Help improve RustSC with page counts and performance measurements. Privacy details