Skip to content
dfkupPublic

About

dfkup packages registry

Topics

Resources

Stars

0 stars

Watchers

1 watching

Forks

Latest commit

 

History

2 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 

Repository files navigation

pkgs, the dfkup packages registry
Consumed by dfkup pkg. One JSON file, no backend.

What is this?

This repository holds the package index for the dfkup scripting language. The dfkup package manager (powered by datpkgr) downloads one file from here:

https://raw.githubusercontent.com/dfkup/pkgs/main/packages.json

and seeds its local database from it. That file is the entire registry.

Entry schema

packages.json is a JSON array. Each entry looks like this:

{
  "name": "myutils",
  "url": "https://github.com/you/myutils",
  "method": "git",
  "tags": [],
  "description": "handy string helpers",
  "license": "MIT",
  "web": "https://github.com/you/myutils"
}
Field Required Notes
name yes Must match the name in the package's package.kup manifest.
url yes Git clone URL of the package repository.
method no Download method. Only git is supported today.
tags yes Informational tag list (may be []). Real versions come from tags.
description yes One-line description shown by package tooling.
license yes Informational license identifier.
web yes Homepage of the package.

An entry missing any required field is skipped silently, as is any entry carrying an alias key. Keep the array sorted by name so diffs stay readable. When in doubt, copy the example above and fill in your values.

Versions

Available versions are discovered from the package repository's git tags at install time, not from this file. Tag releases as semver (v0.1.0, 0.1.0) so version constraints (>= 0.2.0, ^1.0.0) resolve sanely. Repos without semver tags install as rolling HEAD.

Adding a package

  1. Your repository must carry a package.kup manifest at its root whose name matches the entry you add here (see the dfkup README for the manifest format). Exported functions carry the * marker so scripts can call them after import "pkg/<name>".
  2. Add one entry to packages.json (keep it sorted by name).
  3. Open a pull request. Keep the file valid JSON - a trailing comma breaks every dfkup install until it is fixed.

License

MIT. Made by Humans from OpenPeeps. Copyright dfkup & Contributors — All rights reserved.

About

dfkup packages registry

Topics

Resources

Stars

0 stars

Watchers

1 watching

Forks

Releases

Packages

Contributors