Scoop

Features | Installation | Documentation

---

Scoop is a command-line installer for Windows.

What does Scoop do?

Scoop installs programs from the command line with a minimal amount of friction. It:

• Eliminates permission popup windows
• Hides GUI wizard-style installers
• Prevents PATH pollution from installing lots of programs
• Avoids unexpected side-effects from installing and uninstalling programs
• Finds and installs dependencies automatically
• Performs all the extra setup steps itself to get a working program

Scoop is very scriptable, so you can run repeatable setups to get your environment just the way you like, e.g.:

scoop install sudo
sudo scoop install 7zip git openssh --global
scoop install aria2 curl grep sed less touch
scoop install python ruby go perl

If you've built software that you'd like others to use, Scoop is an alternative to building an installer (e.g. MSI or InnoSetup) — you just need to zip your program and provide a JSON manifest that describes how to install it.

Requirements

• Windows 7 SP1+ / Windows Server 2008+
• PowerShell 5 (or later, include PowerShell Core) and .NET Framework 4.5 (or later)
• PowerShell must be enabled for your user account e.g. Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser

Installation

Run the following command from your PowerShell to install scoop to its default location (C:\Users\<user>\scoop)

Invoke-Expression (New-Object System.Net.WebClient).DownloadString('https://get.scoop.sh')

# or shorter
iwr -useb get.scoop.sh | iex

Once installed, run scoop help for instructions.

The default setup is configured so all user installed programs and Scoop itself live in C:\Users\<user>\scoop. Globally installed programs (--global) live in C:\ProgramData\scoop. These settings can be changed through environment variables.

Install Scoop to a Custom Directory by changing SCOOP

$env:SCOOP='D:\Applications\Scoop'
[Environment]::SetEnvironmentVariable('SCOOP', $env:SCOOP, 'User')
# run the installer

Configure Scoop to install global programs to a Custom Directory by changing SCOOP_GLOBAL

$env:SCOOP_GLOBAL='F:\GlobalScoopApps'
[Environment]::SetEnvironmentVariable('SCOOP_GLOBAL', $env:SCOOP_GLOBAL, 'Machine')
# run the installer

Configure Scoop to store downloads to a Custom Directory by changing SCOOP_CACHE

$env:SCOOP_CACHE='F:\ScoopCache'
[Environment]::SetEnvironmentVariable('SCOOP_CACHE', $env:SCOOP_CACHE, 'Machine')
# run the installer

Configure Scoop to use a GitHub API token during searching and checkver by setting SCOOP_CHECKVER_TOKEN

$env:SCOOP_CHECKVER_TOKEN='<paste-token-here>'
[Environment]::SetEnvironmentVariable('SCOOP_CHECKVER_TOKEN', $env:SCOOP_CHECKVER_TOKEN, 'Machine')
# search for an app

Documentation

Multi-connection downloads with aria2

Scoop can utilize aria2 to use multi-connection downloads. Simply install aria2 through Scoop and it will be used for all downloads afterward.

scoop install aria2

By default, scoop displays a warning when running scoop install or scoop update while aria2 is enabled. This warning can be suppressed by running scoop config aria2-warning-enabled false.

You can tweak the following aria2 settings with the scoop config command:

• aria2-enabled (default: true)
• aria2-warning-enabled (default: true)
• aria2-retry-wait (default: 2)
• aria2-split (default: 5)
• aria2-max-connection-per-server (default: 5)
• aria2-min-split-size (default: 5M)
• aria2-options (default: )

Inspiration

• Homebrew
• sub

What sort of apps can Scoop install?

The apps that install best with Scoop are commonly called "portable" apps: i.e. compressed program files that run stand-alone when extracted and don't have side-effects like changing the registry or putting files outside the program directory.

Since installers are common, Scoop supports them too (and their uninstallers).

Scoop is also great at handling single-file programs and Powershell scripts. These don't even need to be compressed. See the runat package for an example: it's really just a GitHub gist.

Contribute to this project

If you'd like to improve Scoop by adding features or fixing bugs, please read our Contributing Guide.

Support this project

If you find Scoop useful and would like to support ongoing development and maintenance, here's how:

• PayPal (one-time donation)

Known application buckets

The following buckets are known to scoop:

• main - Default bucket for the most common (mostly CLI) apps
• extras - Apps that don't fit the main bucket's criteria
• games - Open source/freeware games and game-related tools
• nerd-fonts - Nerd Fonts
• nirsoft - Almost all of the 250+ apps from Nirsoft
• java - A collection of Java development kits (JDKs), Java runtime engines (JREs), Java's virtual machine debugging tools and Java based runtime engines.
• nonportable - Non-portable apps (may require UAC)
• php - Installers for most versions of PHP
• versions - Alternative versions of apps found in other buckets

The main bucket is installed by default. To add any of the other buckets, type:

scoop bucket add bucketname

For example, to add the extras bucket, type:

scoop bucket add extras

Other application buckets

Many other application buckets hosted on Github can be found in the Scoop Directory or via other search engines.