https://github.com/zdharma-continuum/zinit-packages

zinit package repository
https://github.com/zdharma-continuum/zinit-packages

zinit zinit-package zsh

Last synced: 1 day ago
JSON representation

zinit package repository

• Host: GitHub
• URL: https://github.com/zdharma-continuum/zinit-packages
• Owner: zdharma-continuum
• Created: 2021-11-17T17:13:51.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2023-12-24T15:50:26.000Z (11 months ago)
• Last Synced: 2023-12-24T16:43:24.399Z (11 months ago)
• Topics: zinit, zinit-package, zsh
• Language: Shell
• Homepage: https://zdharma-continuum.github.io/zinit/wiki/Zinit-Packages/
• Size: 250 KB
• Stars: 16
• Watchers: 4
• Forks: 3
• Open Issues: 4
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# zinit-packages

🌻 Welcome to [zinit](https://github.com/zdharma-continuum/zinit)'s package repository.

To learn more about zinit packages and how to install them please refer to:

https://zdharma-continuum.github.io/zinit/wiki/Zinit-Packages/

# Developers!

## 🆕 Creating new packages

To create a new package named `foo`:

```zsh

./zinit-pkg-gen.sh create foo

```

This will create a directory named `foo` which contains:

- `default.ices.zsh`: Your source file where you can define your zinit ices and will later be used for generating

  `package.json`

- `package.json`: The file that `zinit pack` actually consumes

To add another profile (as in `zinit pack"PROFILE" for PACKAGE`), for example `bar`:

```zsh

./zinit-pkg-gen.sh create foo bar

```

This will create a new file in your package directory: `bar.ices.zsh`.

## 📄 The package format

As mentionned above you should start by editing your `.ices.zsh` file.

📓 Exactly one zinit call is required in there, multiple `zinit` calls are not supported.

📝 You can also define metadata in your `.ices.zsh` files:

| Variable        | Description                                       | Example Value                               |

| --------------- | ------------------------------------------------- | ------------------------------------------- |

| `AUTHOR`        | Author of the package                             | `zdharma-continuum`                         |

| `DESCRIPTION`   | Description of the package                        | `My amazing blockchain project`             |

| `LICENSE`       | License of the packaged software                  | `GPL-3`                                     |

| `MESSAGE`       | Message to be display when installing             | `Thanks for using zinit pack!`              |

| `NAME`          | Package name (defaults to plugin name if not set) | `stuxnet-monero-miner`                      |

| `REQUIREMENTS`  | List of requirements for this package             | `bgn;tar`                                   |

| `PARAM_DEFAULT` | *Optional* Default `param` ice value              | `MOD -> speed-test`                         |

| `URL`           | Link to the upstream project                      | `https://github.com/zdharma-continuum/null` |

| `VERSION`       | Version of the package                            | `0.0.1`                                     |

Also please refer to the [`null` package](./null/) for an up-to-date example

## 👏 Updating `package.json` files

To generate a `package.json` file for your package run:

```zsh

# Replace these

pkg=null

profile=default

./zinit-pkg-gen.sh gen ${pkg} ${profile}

```

## 🐳 How do I run these?

There's a shorthand subcommand for running a `.ices.zsh` file locally, inside a container:

```zsh

./zinit-pkg-gen.sh run PACKAGE PROFILE

```

Great, but I want to test my `package.json` directly!

Here you go:

```zsh

./zinit-pkg-gen.sh run --pack PACKAGE PROFILE

```