Bee Box documentation · directory: https://beebox.run/docs/reference/cards/ · index: https://beebox.run/docs/reference/cards/index.md · root: https://beebox.run/llms.txt

# publication Card

# Publication cards

A publication card is one publication. Its fields request how the site is
published. The server decides what is actually served.

Fields:

- `title`: the site title.
- `pubId`: the identity of the publication. Generate it one time with
  `bbx pub id`. Never change it.
- `connection`: the connection that the site deploys through.
- `tier`: the requested audience. Use `public`, `secret`, `accounts`, or
  `any-account`.
- `slug`: the requested path on the box's shared hostname. The site is
  served at `/<slug>/`. Use it only with tier `public`.
- `emails`: the reader emails. Use it only with tier `accounts`, and there
  it is required.

The body is for private notes. It is never published.

Put the site files in the card's attach folder. Use exactly one of these:

- `<Name>.attach/static/`: finished files. Markdown files are rendered.
- `<Name>.attach/project/`: a project with `package.json`. Its `dist/`
  folder is published.

Do not copy a publication card. Two cards with one `pubId` is an error. To move or
rename it, use `bbx mv`.

To see what is published, run `bbx pub files <card-path>` or
`bbx pub cat <card-path> <file>`. Add `--pending` to read the candidate.

Do not put approval, the audience that is actually served, the hostname, or
status in this card. The server owns them. A change to `tier`, `slug`, or
`emails` is a request. It waits until a signed-in member approves it.

For the full procedure, read `node_modules/beebox/box-docs/publishing.md`.


## The `contains:` field

Give this card a one-sentence `contains:` — the prime retrieval field for
`bbx search` and listings. How to write a good one (carry the information when
it's concise, never a list of parts, under 200 characters) is in the agent
guide's ABOUT_CARDS section.