Terminal Install Guide

Get started

Install, update or remove Octopus Scanner with one command, and install it on several computers without questions.

1. Before you start

The command installs the same app as the Download page, so the system requirements are the same. You also need:

  • An internet connection: The command downloads Octopus Scanner from this website.
  • Octopus Scanner closed: If it's open, the command stops and asks you to quit it first.
  • Free space: About 600 MB for the app, plus room for the download while it installs: about 250 MB on Windows and 200 MB on a Mac.

On Windows, open PowerShell or Terminal from the Start menu. On a Mac, open Terminal from Applications > Utilities.

2. Run the command

Paste the command for your system, then press Enter or Return.

  • Windows (PowerShell):
    irm https://octopusscanner.com/install | iex
  • macOS (Terminal):
    curl -fsSL https://octopusscanner.com/install | bash

It asks whether you want to install Octopus Scanner. Choose Yes or No with the arrow keys or Tab, then press Enter or Return. You can also press Y or N, and Escape means No.

The question the command asks before it installs anything.
Text description

Example of Terminal on a Mac after running the command: the Octopus Scanner banner, the question Do you want to install Octopus Scanner?, a highlighted Yes button next to a No button and the hint Use the arrow keys or Tab to choose, then press Return.

The question the command asks before it installs anything.
Text description

Example of PowerShell on Windows after running the command: the Octopus Scanner banner, the question Do you want to install Octopus Scanner?, a highlighted Yes button next to a No button and the hint Use the arrow keys or Tab to choose, then press Enter.

On Windows, a new install also asks whether you want a shortcut to Octopus Scanner on your desktop.

If a screen reader such as VoiceOver, NVDA, JAWS or Narrator is running, the command doesn't draw buttons or animations. It asks each question as a line of text, and you type Y or N and press Enter or Return. It also skips animations when your system is set to reduce motion.

3. What the command does

  1. Checks the download information: It confirms that the details of the latest version are signed with the same key the app uses for its own update checks.
  2. Downloads Octopus Scanner: Only from this website, trying again if the connection drops.
  3. Checks the file: It compares the file's SHA-256 hash with the signed details. If either check fails, it stops without installing anything.
  4. Installs it:
    • Windows: Runs the standard Setup without its screens. A new install is for your account only and doesn't ask for administrator permission. If Octopus Scanner is already installed for everyone who uses the computer, that copy is updated instead, and Windows may ask for administrator permission. The offline Terms and Conditions and Third-Party Licences are installed as usual.
    • macOS: Copies the app to the Applications folder, or to the Applications folder in your home folder if you can't change the main one. The ReadMe, Terms and Conditions and Third-Party Licences documents from the disk image are saved in ~/Library/Application Support/Octopus Scanner/ReadMe.
  5. Tidies up: Removes the downloaded file and other temporary files.
Each step is marked as done when it finishes, and an animated indicator shows the current step.
Text description

Example of Terminal on a Mac while installing: Installing Octopus Scanner, then Downloaded, 55 MB, and Checked the file, Signature and SHA-256 verified, each marked done, and Installing in progress after 3 seconds.

Each step is marked as done when it finishes, and an animated indicator shows the current step.
Text description

Example of PowerShell on Windows while installing: Installing Octopus Scanner, then Downloaded, 102 MB, and Checked the file, Signature and SHA-256 verified, each marked done, and Installing in progress after 3 seconds.

When it finishes, it asks whether you want to open Octopus Scanner. The first time you open it, the app asks you to accept the Terms and Conditions and the third-party licences, the same as after a standard install.

4. Update or remove Octopus Scanner

Run the same command again at any time.

  • If a newer version is available: It asks whether you want to update, then installs the update. Your reports and settings are kept.
  • If you have the latest version: It asks whether you want to remove Octopus Scanner. If you choose Yes, it then asks whether to delete your reports, logs and settings as well. The answer starts on No, so they're kept unless you choose otherwise.

Removing Octopus Scanner works like this:

  • Windows: Runs the app's own uninstaller, which also removes its downloaded components, caches and logs. If you chose to delete your data, it also deletes your reports and settings.
  • macOS: Deletes the app and its Open At Login entry. If you chose to delete your data, it also deletes ~/Library/Application Support/Octopus Scanner, the app's caches and its saved preferences.

5. Install without questions

To install or update Octopus Scanner on several computers, set OCTOPUS_YES to 1. The command then installs or updates without asking and doesn't open the app. It never removes Octopus Scanner, and if the latest version is already installed, it changes nothing.

  • Windows (PowerShell):
    $env:OCTOPUS_YES = 1; irm https://octopusscanner.com/install | iex
  • macOS (Terminal):
    curl -fsSL https://octopusscanner.com/install | OCTOPUS_YES=1 bash

6. Browsers and antivirus

The command is a good choice if your browser or Windows SmartScreen blocks the download, because it downloads the installer directly. Your antivirus still checks Octopus Scanner as it installs. If it quarantines the app, see the Security Warnings Guide.

7. If something goes wrong

Each message explains what happened. The command never leaves a half-finished download behind.

  • Couldn't reach octopusscanner.com: Check your internet connection and any proxy settings, then try again.
  • The download information couldn't be verified: Nothing was downloaded. Try again later, or use the Download page.
  • The file doesn't match the official download: The file was damaged or changed on the way, so it wasn't installed. Try again later.
  • There isn't enough free space: Free up the space the message mentions, then run the command again.
  • Octopus Scanner is open: Quit Octopus Scanner, then run the command again.
  • Run this command without sudo: On a Mac, the command installs Octopus Scanner for your own account, so it doesn't need sudo. Run it again without it.
  • PowerShell is restricted on this computer: Your organisation limits what PowerShell can run, so the command can't check the download. Download Octopus Scanner from the Download page instead.
  • This installer needs to ask you a question: The command was run somewhere it can't ask you, such as a script. Run it in a PowerShell or Terminal window, or install without questions.

If you stop the command with Ctrl+C, it says Cancelled. Nothing was changed. If you stop it while it's installing or removing, it says Stopped part-way through. Run the command again to finish.

8. Compared with the standard installer

The standard installer from the Download page is more flexible. On Windows, it lets you choose whether to install for everyone who uses the computer or just your account. On a Mac, you can choose where to put the app, although the Applications folder is recommended.

Was this page helpful? Email your feedback.