new-catalog
Creates a Gravitee Lab catalog, a folder of add-ons, setups and playgrounds to keep or to share, when someone has built something and has nowhere to put it.
- License 许可
- AGPL-3.0
- 最近更新
- 2026-11-09
- Stars
- ★ 4
- Forks
- 1
01 前言 Front Matter
- name
- new-catalog
- description
- Creates a Gravitee Lab catalog, a folder of add-ons, setups and playgrounds to keep or to share, when someone has built something and has nowhere to put it.
03 SKILL.md 正文
New catalog
A catalog is a folder (a Git repository once it is published) that holds add-ons, setups and playgrounds and a catalog.yml
that says what it is. A person who builds something to keep, or to share with a team, makes one: the items in it are the
same as personal ones, at the same depth, and the Lab shows them as the catalog's. The Lab UI's New catalog on the Catalogs
page does the same from one field, the name. The rules of the format are in docs/writing-a-catalog.md.
-
Read
AGENTS.mdanddocs/writing-a-catalog.md. -
Settle what the request does not say. Infer what you can, ask the rest:
- Its name, as people read it (at most 40 characters), and its id: 2 to 24 lowercase letters, digits and dashes, the
first a letter. The id is the namespace of every item (
@<id>/<name>) and is stable forever. It is not a word the Lab reserves (catalog.py newrefuses one and says so) and not the id of a catalog the person has (python3 -I lab-ui/catalog.py listlists them). - A description: one line, at most 90 characters.
- Its license, as an SPDX identifier (
Apache-2.0). Without one the catalog saysUNLICENSED, a stub that asks for a choice. - Its folder: under the home folder, so that Docker can share it, and not there yet.
~/gravitee-lab-catalogs/<id>when the person has no preference.
- Its name, as people read it (at most 40 characters), and its id: 2 to 24 lowercase letters, digits and dashes, the
first a letter. The id is the namespace of every item (
-
Render it from the Lab's folder, then write the description in the
catalog.ymlof the new folder:python3 -I lab-ui/catalog.py new <folder> --id <id> --name "<Name>" --license <SPDX> --localLink it, so that the Lab shows it on the Catalogs page and offers it where an item is created and shared:
python3 -I lab-ui/catalog.py link <folder> -
Check it:
python3 -I lab-ui/catalog.py check <id>prints "All good" for a catalog that is ready. Add items with thenew-addon,new-setupandnew-playgroundskills, choosing this catalog, and share a personal item into it with theshare-itemskill. -
Tell the person where the folder is. Nothing ran
git init: to publish it, they make a repository of the folder, commit and push it, and anyone adds it by its address from the Catalogs page.docs/catalogs.mdsays how.
04 同仓库更多 Skills
acme-bakery-complaint-handling
How the Acme Bakery assistant takes a customer complaint. It listens, records the facts, says what happens next and hands the case to a teller when money or a card is involved. Use when a customer is unhappy, disputes a charge or reports a mistake.
share-item
Shares a personal Gravitee Lab add-on, setup or playground to a catalog, as a branch to propose or a copy into a folder.
prepare-pull-request
Prepares a Gravitee Lab change for review by running the checks that match it and printing the pull request description.
new-setup
Creates a Gravitee Lab setup, personal or shared, when someone wants add-ons that start and stop as one.
new-playground
Creates a Gravitee Lab playground, personal or shared, when someone wants a use case with its apps, sample data and guide.
new-catalog
Creates a Gravitee Lab catalog, a folder of add-ons, setups and playgrounds to keep or to share, when someone has built something and has nowhere to put it.