feature:info

Introduction

feature:info shows a feature’s contract card without cloning it. Use it to see what a feature provides and needs before you install it.

splent feature:info notes

  splent-io/splent_feature_notes  v1.4.0  [full]
  ────────────────────────────────────────────────────────────
  Notes owned by their author

  models        Note
  services      NotesService
  routes        /notes
  hooks         layout.authenticated_sidebar

  requires      auth ✔

  used by       notes_tags, reports

  pypi          published (latest 1.4.0)
  repo          https://git.splent.io/splent-io/splent_feature_notes

  source: cache

  install with: splent feature:install splent-io/splent_feature_notes

It lists what the feature provides, what it requires, with ✔ or ✗ missing for your selected product, and who uses it. When your product already has the feature, the header says ● installed.

Naming the feature

splent feature:info notes
splent feature:info splent_feature_notes
splent feature:info splent-io/splent_feature_notes

A short name, the package name or org/repo all work, with the organisation spelt splent-io or splent_io.

Where the data comes from

The card comes from the marketplace index, .splent_cache/marketplace/index.json, or from SPLENT_INDEX_URL when there is no local copy. --refresh fetches SPLENT_INDEX_URL again first.

When the index does not list the feature, it reads the feature’s pyproject.toml on the forge at its latest tag, under SPLENT_DEFAULT_ORG or splent-io for a bare name. The card then ends with source: <forge host> (live).

Getting the raw entry

splent feature:info notes --json

--json prints the whole index entry, ready for jq or a script.

Reference

Argument or option	Description
`FEATURE_REF`	A short name, the package name or `org/repo`
`--refresh`	Fetch the index from `SPLENT_INDEX_URL` again
`--json`	Print the raw entry as JSON

It exits 1 with Feature '<name>' not found. when neither the index nor the forge has it. Check the name and organisation, or build an index with marketplace:index.