{"id":20162593,"url":"https://github.com/zdharma-continuum/zinit-packages","last_synced_at":"2025-04-10T00:36:03.405Z","repository":{"id":45874281,"uuid":"429134985","full_name":"zdharma-continuum/zinit-packages","owner":"zdharma-continuum","description":"zinit package repository","archived":false,"fork":false,"pushed_at":"2023-12-24T15:50:26.000Z","size":257,"stargazers_count":28,"open_issues_count":4,"forks_count":3,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-03-24T02:21:54.138Z","etag":null,"topics":["zinit","zinit-package","zsh"],"latest_commit_sha":null,"homepage":"https://zdharma-continuum.github.io/zinit/wiki/Zinit-Packages/","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/zdharma-continuum.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-11-17T17:13:51.000Z","updated_at":"2025-03-01T15:21:37.000Z","dependencies_parsed_at":"2023-12-24T16:48:37.426Z","dependency_job_id":null,"html_url":"https://github.com/zdharma-continuum/zinit-packages","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zdharma-continuum%2Fzinit-packages","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zdharma-continuum%2Fzinit-packages/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zdharma-continuum%2Fzinit-packages/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zdharma-continuum%2Fzinit-packages/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zdharma-continuum","download_url":"https://codeload.github.com/zdharma-continuum/zinit-packages/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247749956,"owners_count":20989714,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["zinit","zinit-package","zsh"],"created_at":"2024-11-14T00:25:51.025Z","updated_at":"2025-04-10T00:36:03.376Z","avatar_url":"https://github.com/zdharma-continuum.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# zinit-packages\n\n🌻 Welcome to [zinit](https://github.com/zdharma-continuum/zinit)'s package repository.\n\nTo learn more about zinit packages and how to install them please refer to:\n\nhttps://zdharma-continuum.github.io/zinit/wiki/Zinit-Packages/\n\n# Developers!\n\n## 🆕 Creating new packages\n\nTo create a new package named `foo`:\n\n```zsh\n./zinit-pkg-gen.sh create foo\n```\n\nThis will create a directory named `foo` which contains:\n\n- `default.ices.zsh`: Your source file where you can define your zinit ices and will later be used for generating\n  `package.json`\n- `package.json`: The file that `zinit pack` actually consumes\n\nTo add another profile (as in `zinit pack\"PROFILE\" for PACKAGE`), for example `bar`:\n\n```zsh\n./zinit-pkg-gen.sh create foo bar\n```\n\nThis will create a new file in your package directory: `bar.ices.zsh`.\n\n## 📄 The package format\n\nAs mentionned above you should start by editing your `.ices.zsh` file.\n\n📓 Exactly one zinit call is required in there, multiple `zinit` calls are not supported.\n\n📝 You can also define metadata in your `.ices.zsh` files:\n\n| Variable        | Description                                       | Example Value                               |\n| --------------- | ------------------------------------------------- | ------------------------------------------- |\n| `AUTHOR`        | Author of the package                             | `zdharma-continuum`                         |\n| `DESCRIPTION`   | Description of the package                        | `My amazing blockchain project`             |\n| `LICENSE`       | License of the packaged software                  | `GPL-3`                                     |\n| `MESSAGE`       | Message to be display when installing             | `Thanks for using zinit pack!`              |\n| `NAME`          | Package name (defaults to plugin name if not set) | `stuxnet-monero-miner`                      |\n| `REQUIREMENTS`  | List of requirements for this package             | `bgn;tar`                                   |\n| `PARAM_DEFAULT` | *Optional* Default `param` ice value              | `MOD -\u003e speed-test`                         |\n| `URL`           | Link to the upstream project                      | `https://github.com/zdharma-continuum/null` |\n| `VERSION`       | Version of the package                            | `0.0.1`                                     |\n\nAlso please refer to the [`null` package](./null/) for an up-to-date example\n\n## 👏 Updating `package.json` files\n\nTo generate a `package.json` file for your package run:\n\n```zsh\n# Replace these\npkg=null\nprofile=default\n\n./zinit-pkg-gen.sh gen ${pkg} ${profile}\n```\n\n## 🐳 How do I run these?\n\nThere's a shorthand subcommand for running a `.ices.zsh` file locally, inside a container:\n\n```zsh\n./zinit-pkg-gen.sh run PACKAGE PROFILE\n```\n\nGreat, but I want to test my `package.json` directly!\n\nHere you go:\n\n```zsh\n./zinit-pkg-gen.sh run --pack PACKAGE PROFILE\n```\n\n\u003c!-- vim: set ft=markdown et ts=2 sw=2 tw=80 --!\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzdharma-continuum%2Fzinit-packages","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzdharma-continuum%2Fzinit-packages","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzdharma-continuum%2Fzinit-packages/lists"}