Adding a remote

Adding a remote

This section is designed to show you how to set your package in a way that it can be installed with fox.

💡 There is an official remote with hand-cured packages that you can install right away. You can find it here. If you have a cool package that you want to share with the whole world, feel free to submit a PR, and I’ll gladly check it out.

How to make my package installable with fox

To install a package, first fox needs to know where to find it. To achieve this, you need to add a remote to your repositories file, which is located at ~/.fox/repositories.yaml.

The remotes section of this YAMl file consists of a list of items with the following format:

remotes:
- url: "" # string - a url where to find a packages YAML file
  type: "github" # string - either 'open' or 'github'

The value for url is a string that fox will use to look for a YAMl file with your packages. The value for type is a string that can be either github or open. Use open if the url is public (eg. on your own server, an S3 bucket, etc), or use github if the file is hosted on a private/public GitHub repo.

Example ~/.fox/repositories.yaml:

remotes:
- url: "repos/<OWNER>/<REPO_NAME>/contents/packages.yaml"
  type: "github"
- url: "https://raw.githubusercontent.com/ricardofabila/test/main/repositories.yaml"
  type: "open"

Note: notice how the the url for the github type is not a full url, but a GitHub path.

You can edit the file directly using your preferred editor to add remotes, but you can also use the following command:

  fox add remote --url "the url" --type "open|github"

Use fox add remote -h for help.

Continue to know what this remote file consists of.

← Introduction
Creating a remote →