Examples

Platform spec article

Examples

Back to pckg client contract ◎ Open feature in platform map

Spec standingStandard

Owner

Piotr Mikstacki pmikstacki@cybernomad.it

Submitter

Piotr Mikstacki pmikstacki@cybernomad.it

Current document

ADRs (2)

1. 0001-hub-authority Hub authority Accepted

   Hub authority

   Context

   One client story.

   Decision

   Hub owns HTTP and auth.

   Consequences

   Extension defers.

   Verification anchors

   beskid_pckg; pckgClient.

   Open full ADR page

2. 0002-registry-assigned-versions Registry versions Accepted

   Registry versions

   Context

   Manual semver drift.

   Decision

   Registry-assigned publish versions in routine flows.

   Consequences

   UI shows server version.

   Verification anchors

   publish API tests.

   Open full ADR page

Articles

• Contracts and edge cases Registry client guarantees and failure modes. article Standard
• Design model Conceptual model for the Beskid pckg registry client (`beskid_pckg`). article Standard
• Examples Example `beskid pckg` invocations and configuration. article Standard
• FAQ and troubleshooting Common pckg client and registry issues. article Standard
• Flow and algorithm Pack, upload, and query flows for the pckg registry client. article Standard
• Verification and traceability Tests and traceability for the pckg client contract. article Standard

History

0 revisions (git unavailable at build; counts may be empty)

Open full history on GitHub

No commits recorded for this path.

Completeness

OKfeature · 3 SpecSection(s) · 0 H2 heading(s)

Section id	Required	Found
what-this-feature-specifies	yes	yes
implementation-anchors	yes	yes

Full tree: run pnpm verify:platform-spec-layout (writes src/generated/platform-spec-layout-report.json).

Related spec docs

• Feature
  pckg client contract

  Parent feature hub

Pack a library project

beskid pckg pack --project compiler/corelib/beskid_corelib/Project.proj

Produces a .bpk with README.md, sources, and .beskid/docs/ when present.

Publish with API key

export BESKID_PCKG_URL=https://pckg.example/
export BESKID_PCKG_API_KEY=...
beskid pckg upload path/to/package.bpk

Exact subcommand names follow PckgCommand in cli.rs (use beskid pckg --help in installed CLI).

Repository config file

.beskid/pckg/repositories.json:

{
  "repositories": {
    "default": { "api_key": "..." }
  }
}

Maps to registry aliases in Workspace.proj.

CI corelib publish

Compiler CI uses BESKID_PCKG_KEY to publish the corelib package identity after build—same client stack as local beskid pckg with injected secrets.