⚡ Quick Start

This small section is meant to help you get started in no time.

Dependencies:

⚓ Required

This tool is as zero-dependencies as it can possibly get.

  • GitHub CLI to install packages. Don’t worry if you don’t have it already, just follow the installation instructions below; you can run fox gh to install it 😉.

That’s it. Seriously, you don’t need to install anything more.

Why the GitHub CLI?

In order to install packages from private repos, you need to have an access token. GitHub’s official CLI manages these automatically for you.

Plus, GitHub APIs are rate-limited when using them anonymously to avoid abuse, by using the gh CLI we can avoid any issues.

Installation

Getting started is as easy as 1, 2, 3.

1.) Just run:

sudo curl -fsSL "install.getfox.sh" | bash

Follow the on-screen instructions to add fox to your $PATH.

2.) Install the official GitHub CLI, if you don’t already have it. Relax, you can run fox gh to install it 😉. Then run gh auth. To setup authentication. I recommend using ssh keys, so you never have to use a password.

3.) That’s it! That wasn’t so bad, was it?

If you did everything correctly you can try running the following command:

fox doctor

This will check your environment for potential problems and possible enhancements.

How to install packages

There are lots of amazing packages in the central repository of public packages installable by fox (find it here).

Just run the following command to see the list:

fox list

Once you have a package that you want to install, just do a quick:

fox install <package-name>

And presto! You installed your first package.

Go further

Learn how to make your own packages installable using fox in the next section.

← Introduction
Introduction →