Scoop README

The project's README from github.com/ScoopInstaller/Scoop. As one markdown file: README.md.

Scoop

Features | Installation | Documentation

Code Size Repository size Scoop Core CI Tests Discord Chat Gitter Chat License

Scoop is a command-line installer for Windows.

What does Scoop do?

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

Scoop is quite script-friendly. Your environment can become the way you like by using repeatable setups. For example:

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 have built software that you would like others to use, Scoop is an alternative to building an installer (like MSI or InnoSetup). You just need to compress your app to a .zip file and provide a JSON manifest that describes how to install it.

Installation

Run the following commands from a regular (non-admin) PowerShell terminal to install Scoop:

Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser
Invoke-RestMethod -Uri https://get.scoop.sh | Invoke-Expression

Note: The first command makes your device allow running the installation and management scripts. This is necessary because Windows 10 client devices restrict execution of any PowerShell scripts by default.

It will install Scoop to its default location:

C:\Users\<YOUR USERNAME>\scoop

You can find the complete documentation about the installer, including advanced installation configurations, in ScoopInstaller/Install. Please create new issues there if you have questions about the installation.

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:

Inspiration

What sort of apps can Scoop install?

The apps that are most likely to get installed fine with Scoop are those referred to as "portable" apps. These apps are compressed files which can run standalone after being extracted. This type of apps does not produce side effects like changing the Windows Registry or placing files outside the app directory.

Scoop also supports installer files and their uninstallation methods. Likewise, it can handle single-file apps and PowerShell scripts. These do not even need to be compressed. See the runat package for an example: it is simply a GitHub gist.

Contribute to this project

If you would 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 the ongoing development and maintenance of this project, you can donate here:

Known application buckets

The following buckets are known to Scoop:

The main bucket is installed by default. You can make use of more buckets by typing:

scoop bucket add <name>

For example, to add the extras bucket, type:

scoop bucket add extras

You would be able to install apps from the extras bucket now.

Other application buckets

Many other application buckets hosted on GitHub can be found on ScoopSearch or via other search engines.

Scoop (ScoopInstaller/Scoop)

Searching Database…

24.7K ·GitHub
Scoop
What is this?Scoop is a command-line installer for Windows that lets you install apps from the terminal with minimal friction, similar to Homebrew on macOS.
Is this a GUI app or a CLI tool?It is a PowerShell command-line tool; there is no graphical interface, apps are installed and managed entirely through terminal commands.
How do I install Scoop itself?Run the install commands from a regular, non-admin PowerShell terminal; it installs to C:\Users\ \scoop by default. Full instructions and advanced config options live in the separate ScoopInstaller/Install repo.
Do I need to change any Windows settings first?You need to allow running PowerShell scripts, since Windows 10 restricts script execution by default; the installer's first command sets that execution policy.
What kind of apps actually install cleanly with Scoop?Portable, standalone zipped apps work best since they don't touch the registry or write files outside the app directory. Scoop also supports regular installers and single-file/script apps, but those in the 'nonportable' bucket may still trigger UAC prompts.
Does this only work on Windows?Yes, Scoop is built specifically for Windows and written in PowerShell.
What buckets does Scoop ship with besides main?Known buckets include extras (apps not fitting main), games, nerd-fonts, nirsoft, sysinternals, java, nonportable, php, and versions (for alternate app versions). Only main is installed by default; others are added with 'scoop bucket add'.
Can I speed up downloads?Yes, installing aria2 through Scoop enables multi-connection downloads automatically for all future installs, with tunable settings like aria2-split and aria2-max-connection-per-server via scoop config.
Can I distribute my own app through Scoop?Yes, you just zip your app and write a JSON manifest describing how to install it, making Scoop an alternative to building a traditional MSI or InnoSetup installer.
What inspired Scoop?Scoop was inspired by Homebrew (macOS) and a tool called Sub.
What are similar projects?winget-cli, Winhance, MediaCreationTool.bat, winutil-cn, choco, tubatools, tiny11builder, UniGetUI
Which topics is it in?scoop, registry-tweaks, download, windows-10, windows-11, powershell, package-manager, installer, windows-app, sysadmin, utility, command-line
Creator
ScoopInstaller
Size
14.2 MB
Stars
24.7K
Updated
CommitSep 30Releasev0.6.0Sep 30
Age
13y
Commits · 90 Days