https://github.com/oh-my-fish/packages-main

Primary Oh My Fish package repository.
https://github.com/oh-my-fish/packages-main

fish fish-packages fish-shell shell

Last synced: 3 months ago
JSON representation

Primary Oh My Fish package repository.

• Host: GitHub
• URL: https://github.com/oh-my-fish/packages-main
• Owner: oh-my-fish
• License: mit
• Created: 2016-10-22T19:55:23.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2024-06-26T17:56:28.000Z (4 months ago)
• Last Synced: 2024-06-26T22:30:20.415Z (4 months ago)
• Topics: fish, fish-packages, fish-shell, shell
• Homepage:
• Size: 231 KB
• Stars: 234
• Watchers: 15
• Forks: 134
• Open Issues: 28
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Codeowners: CODEOWNERS

Awesome Lists containing this project

README

        
# [Oh My Fish][oh-my-fish] official package repository

Primary package repository for the [Oh My Fish][oh-my-fish] [Fish shell][fish] framework.

This repository contains a list of public Fish packages that can be installed by name using Oh My Fish. The goal of this repo is to maintain a discoverable index of quality Fish packages that can easily be maintained by the Fish community.

## Repository format

Packages are referenced in the repository using property files located in the `packages/` directory. The actual code of each package is stored in separate, individual Git repositories maintained by the package maintainer themselves. This keeps control of the package in the owner's hands, but still allows easy sharing of the package.

The name of each property file indicates the package name, and the various properties in the file describe the package and how it can be installed. These are the properties currently used:

- `type`: The type of package. Can be `plugin` or `theme`.

- `repository`: A clonable Git URL to the package source repository.

- `maintainer`: The name and email of the maintainer of the package.

- `description`: A short description of the package.

## Submitting a package

Want to add your own package to the public repository? First, make a fork of this Git repository. Then create a package description file inside the `packages/` directory. The file name should be the name of your package without any file extensions, and should contain at least these properties:

```

type = plugin

repository = YOUR-PACKAGE-URL

maintainer = YOUR-NAME 

description = YOUR-PACKAGE-DESCRIPTION

```

Be sure to use a clonable Git URL for your package. If your package is a theme, use `type = theme` instead.

Once you've created and committed your package description file, [open a pull request][new-pr] with your change, and the repository maintainers will review your submission and merge it in to the main repo.

Once your pull request is merged, your package will be immediately available for all users to install!

[fish]: http://fishshell.com

[new-pr]: https://github.com/oh-my-fish/packages-main/pull/new/master

[oh-my-fish]: https://github.com/oh-my-fish/oh-my-fish