Skip to content

Web Terminal โ€‹

Web Terminal gives you a browser-based SSH shell for your site. Run WP-CLI commands, inspect files, and fix things directly from the InstaWP dashboard โ€” no terminal app, SSH key, or local setup required.

In this documentation, we will explore:

Let's get started ๐Ÿš€

The Web Terminal is available on Sandbox plans and above and requires SSH to be enabled for the site. View Pricing here.

What is the Web Terminal? โ€‹

The Web Terminal is a full shell session for your site, rendered right inside the dashboard. It runs every command as your site's SSH user, in your site's web root โ€” the same environment you'd get by connecting over SSH from your own machine.

Why use it? โ€‹

  • No local setup: No SSH client, key pair, or connection details to configure
  • WP-CLI on tap: Run wp commands to manage plugins, themes, users, options, and the database
  • Fast troubleshooting: Check files, permissions, and logs without opening an SFTP client
  • Works anywhere: Any browser, including machines where outbound SSH (port 22) is blocked
  • Built-in file editor: nano/vim open a simple editor overlay โ€” edit and save without leaving the page

Who should use this feature? โ€‹

  • Developers running WP-CLI, checking files, or debugging a site
  • Agencies doing quick maintenance on a client site without setting up SSH access
  • Support and QA reproducing an issue or verifying a fix on a live sandbox

How to Open the Web Terminal โ€‹

Step 1: Go to your Sites page and click the site you want to work on.

Step 2: In the site menu, expand Connectivity and click Web Terminal.

Expanding Connectivity in the site menu and selecting Web Terminal

Step 3: If SSH isn't enabled yet for this site, you'll see Enable SSH to use the Web Terminal. Click Enable SSH and wait a few seconds while it's provisioned.

The Enable SSH prompt on the Web Terminal page

Step 4: The terminal opens with a prompt in your site's web root, ready for commands.

Note: Enabling SSH here is the same as enabling it on the SFTP/SSH page โ€” you only need to do it once per site.

Running Commands โ€‹

Type a command and press Enter. Output is printed below the prompt, exactly as it would be over SSH.

Running WP-CLI and shell commands in the InstaWP Web Terminal

Handy commands to start with:

CommandWhat it does
wp core versionShow the WordPress version
wp plugin listList plugins and their status
wp plugin deactivate <slug>Deactivate a misbehaving plugin
wp theme listList installed themes
wp user listList site users
wp db optimizeOptimize the database
wp cache flushFlush the object cache
ls -la ยท cd wp-content ยท tail -n 50 debug.logExplore files and read logs

Shortcuts the terminal supports:

  • โ†‘ / โ†“ โ€” cycle through your command history
  • Tab โ€” autocomplete file and directory names
  • Ctrl+C โ€” cancel a command that's still running
  • clear (or the Clear button, top right) โ€” clear the screen
  • cd โ€” your working directory persists between commands

Tip: Commands run in your site's public_html folder by default, so wp commands work straight away with no --path flag.

Editing Files in the Terminal โ€‹

Full-screen editors like nano and vim can't run inside a web terminal, so InstaWP intercepts them and opens a built-in editor overlay instead.

Run nano <file> (or vim/vi) and the file opens in an editable panel:

The built-in file editor overlay opened from the Web Terminal

  • Ctrl+S โ€” save your changes (a Saved โœ“ confirmation appears in the header)
  • Esc or โœ• โ€” close the editor and return to the prompt

Tip: Always take a backup before editing a live file such as .htaccess, functions.php, or wp-config.php.

What You Can and Can't Do โ€‹

You can:

  • Run any command your site's SSH user can run โ€” WP-CLI, git, composer, curl, file and archive tools
  • Read and write anything inside your site user's home directory
  • Chain commands with &&, pipes, and redirects

You can't:

  • Run commands as root โ€” there's no sudo; the session runs as the unprivileged site user
  • Read other customers' files โ€” standard Linux permissions apply, so anything outside your own user's files returns Permission denied
  • Stay outside your home directory โ€” you can cd anywhere you have read access, but the prompt returns to your site's folder on the next command; only paths inside your home are kept as the working directory
  • Run interactive/long-lived programs โ€” each command runs to completion with a timeout (60 seconds by default), so avoid things like top, watch, sudo, or an unbounded tail -f

Security note: Web Terminal activity is recorded in your site's Activity Log (Advanced โ†’ Activity Log), so you can see when commands were run and by whom.

Troubleshooting โ€‹

"Please enable SSH to use the terminal" โ€‹

Problem: Commands stop working and every command returns this message.

Solutions:

  • SSH has been turned off for the site. Reload the Web Terminal page and click Enable SSH again
  • Check the SFTP/SSH page โ€” the Enable SSH toggle should be ON
  • If SSH keeps switching off, your account may be over its plan usage limits โ€” contact support

A command hangs or times out โ€‹

Problem: A command produces no output and eventually errors out.

Solutions:

  • Each command has a time limit (60 seconds by default). Long jobs โ€” large imports, full-site searches โ€” should be split into smaller commands
  • Press Ctrl+C to cancel and get your prompt back
  • Interactive programs (top, htop, watch, tail -f) never return, so they'll always time out โ€” use a bounded form like tail -n 100 debug.log

"Permission denied" when writing a file โ€‹

Problem: A command or a save from the file editor fails with a permissions error.

Solutions:

  • Run Fix File/Folder Permissions from Site Tools and try again
  • Confirm the path is inside your site's home directory โ€” anything outside it is blocked
  • The terminal has no sudo, so files owned by root can't be modified

The terminal is greyed out with an upgrade prompt โ€‹

Problem: You see "You need the Sandbox plan or higher to use the Web Terminal."

Solution: The Web Terminal isn't available on free sites. Upgrade the site to Sandbox or higher to unlock it.

FAQs โ€‹

Is the Web Terminal the same as SSH? โ€‹

Yes โ€” it's the same SSH access, just driven from your browser instead of a local SSH client. It uses the same credentials and the same environment. If you prefer your own terminal, the connection details are on the SFTP/SSH page.


Do I need to add an SSH key? โ€‹

No. The Web Terminal authenticates through your InstaWP dashboard session, so there are no keys to generate or upload. SSH keys are only needed if you connect from your own machine.


Can I run WP-CLI commands? โ€‹

Yes โ€” WP-CLI is pre-installed and the terminal starts in your site's web root, so wp commands run without extra flags.


Is it safe to use on a production site? โ€‹

The terminal is as safe as any SSH session โ€” which means commands take effect immediately and some are irreversible. Take a backup before running anything destructive, and never run a command you don't understand.


Why won't nano or vim open normally? โ€‹

Full-screen text editors need an interactive terminal, which a web-based shell can't provide. InstaWP detects these commands and opens its own file editor instead, so you still get to edit and save the file.


Can other people on my team use it? โ€‹

Anyone with dashboard access to the site can open the Web Terminal. Commands are attributed to the user who ran them in the site's Activity Log.


Docs are open โ€” edit on GitHub. Built with VitePress.