-
Notifications
You must be signed in to change notification settings - Fork 0
Document supplementary files, archive 0.2, per-file lockfiles, first-class README, and adapter API 0.1 migration
#460
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -23,6 +23,7 @@ facet create ./my-facet \ | |
| --version 0.1.0 \ | ||
| --skill greet --agent helper --command run \ | ||
| --json # headless scaffold, machine-readable result | ||
| facet create ./bare --name bare --skill greet --no-readme # skip the default README | ||
| ``` | ||
|
|
||
| ## Flags | ||
|
|
@@ -44,7 +45,11 @@ facet create ./my-facet \ | |
| </ResponseField> | ||
|
|
||
| <ResponseField name="--skill / --agent / --command" type="repeatable"> | ||
| An asset to scaffold. Repeat per asset; at least one is required in headless mode. Asset names must be kebab-case. | ||
| An asset to scaffold. Repeat per asset; at least one is required in headless mode. Asset names are single-segment [Agent Skills names](/specification/manifest#asset-names); a skill and command can't share a name. | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
The documented shared namespace is enforced only by the interactive wizard. In headless mode, Useful? React with 👍 / 👎. |
||
| </ResponseField> | ||
|
|
||
| <ResponseField name="--no-readme" type="boolean"> | ||
| Skip the default `README.md`. `facet create` writes and declares an editable `README.md` (seeded from the name and description) by default; pass `--no-readme` to scaffold without it. | ||
|
Comment on lines
+51
to
+52
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
When users run Useful? React with 👍 / 👎. |
||
| </ResponseField> | ||
|
|
||
| <ResponseField name="--force" type="boolean"> | ||
|
|
@@ -79,17 +84,19 @@ After scaffolding, validate with [`facet build --verify`](/cli/authoring/build), | |
| 3. **Version** -- defaults to `0.0.0`. | ||
| 4. **Privacy** -- choose Public (the default) or Private. | ||
| 5. **Assets** -- add skills, agents, and commands by name. | ||
| 6. **Confirmation** -- review the summary -- and confirm. | ||
| 6. **README** -- enabled by default. The wizard seeds `README.md` from the name and description; open the editor to customize it, or toggle it off. Edited content is preserved even if you change the name or description later. | ||
| 7. **Confirmation** -- review the summary — which lists `README.md` when enabled — and confirm. | ||
|
|
||
| ## Generated files | ||
|
|
||
| On confirmation, the wizard writes: | ||
|
|
||
| - `facet.json` -- the manifest with named asset descriptors | ||
| - `facet.json` -- the manifest with named asset descriptors (and `README.md` in top-level `files` when README is enabled) | ||
| - `README.md` -- editable README, written and declared by default (skip with `--no-readme`) | ||
| - `skills/<name>/SKILL.md` -- starter skill template (Agent Skills directory convention) | ||
| - `agents/<name>.md` -- starter agent template | ||
| - `commands/<name>.md` -- starter command template | ||
|
|
||
| Content files are markdown. Optional YAML front matter [survives the build untouched](/specification/build#steps); at install time the manifest's `name`, `description`, and any per-adapter extras are merged on top of whatever the author wrote. | ||
| Content files are markdown. A primary asset file (skill, agent, command) carries **no** YAML front matter — asset metadata lives in the manifest. `README.md` and other [supplementary files](/specification/manifest#supplementary-files) are written verbatim. | ||
|
|
||
| After creating the project, use `facet edit` to iterate on your facet, or `facet build` to validate and package it. | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -78,12 +78,16 @@ facet modify agent helper --description "Reviews code" | |
|
|
||
| ### Rename an asset | ||
|
|
||
| Renames the manifest key and moves the asset's file (removing the now-empty skill directory, for skills). | ||
| Renames the manifest key and moves the asset's primary file (removing the now-empty skill directory, for skills). | ||
|
|
||
| ```sh | ||
| facet modify command run --rename start | ||
| ``` | ||
|
|
||
| <Note> | ||
| `facet modify` operates on asset primaries. To adopt, move, or reconcile a skill's [companion files](/specification/manifest#supplementary-files) or top-level supplementary files, use [`facet edit`](/cli/authoring/edit). | ||
| </Note> | ||
|
Comment on lines
+87
to
+89
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
For a skill that has declared companions, Useful? React with 👍 / 👎. |
||
|
|
||
| ### Remove an asset | ||
|
|
||
| Removes the manifest descriptor and deletes the asset's file. | ||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This publishes a July 23 “now” release announcement even though the same change leaves the held CLI release gate unfinished and adds no
agent-facetschangeset. Users of the released CLI will follow the documented--no-readme, archive0.2, and adapter0.1migration paths before a CLI package exposing them exists. Keep this information in unreleased documentation, or add the<Update>with the final CLI release.AGENTS.md reference: docs/changelog/AGENTS.md:L91-L109
Useful? React with 👍 / 👎.