Skip to content

ScoopInstaller/BucketTemplate

Scoop Bucket Template

Template bucket for Scoop, the Windows command-line installer.

How do I use this template?

  1. Generate your own copy of this repository with the "Use this template" button.
  2. Allow all GitHub Actions:
    • Navigate to Settings - Actions - General - Actions permissions.
    • Select Allow all actions and reusable workflows.
    • Then Save.
  3. Allow writing to the repository from within GitHub Actions:
    • Navigate to Settings - Actions - General - Workflow permissions.
    • Select Read and write permissions.
    • Then Save.
  4. Document the bucket in README.md.
  5. Replace the placeholder repository string in bin/auto-pr.ps1.
  6. Create new manifests by copying bucket/app-name.json.template to bucket/<app-name>.json.
  7. Commit and push changes.
  8. If you'd like your bucket to be indexed on https://scoop.sh, add the topic scoop-bucket to your repository.

How do I install these manifests?

After manifests have been committed and pushed, run the following:

scoop bucket add <bucketname> https://github.com/<username>/<bucketname>
scoop install <bucketname>/<manifestname>

How do I contribute new manifests?

To make a new manifest contribution, please read the Contributing Guide and App Manifests wiki page.