Commands

collaboration:init

Scaffolds the parts of an installation that depend on your app rather than on the package.

node ace collaboration:init
node ace collaboration:init --engine=partykit

It writes three things:

1. app/collaboration/documents/ — the folder the codegen hook scans. Empty at first.
2. Migrations for collab_documents, collab_versions and collab_comments — only when a database is configured. See Lucid storage.
3. partykit-worker/ — only with --engine=partykit: the party implementation, its package.json and a partykit.toml with your app's base URL already filled in. It also prints the deployment steps, including partykit secret put COLLAB_JWT_SECRET.

It does not publish config/collaboration.ts or register the provider — those come from node ace configure @adonis-agora/collaboration, which node ace add runs for you. And it does not register the REST routes: the provider does that at boot.

collaboration:prune

Applies a retention policy to the version history: keeps the most recent versions of each document and deletes the rest. Nothing runs it for you — put it in cron, a scheduler task, or a deploy hook.

node ace collaboration:prune --keep=20
node ace collaboration:prune --keep=5 --doc=researches/42/writing
node ace collaboration:prune --keep=20 --dry-run

It prints how many versions were removed. A --keep that is not a non-negative integer fails the command instead of deleting everything, and --keep=0 is a real value: it deletes every version.

The same call from code is collaboration.current.pruneVersions({ keep: 20 }), which returns the number removed.

make:collab-document

Declares a document type: its name, the comment spaces it has, and the anchor kinds those comments may use.

node ace make:collab-document researches/writing
node ace make:collab-document whiteboards/board --spaces=canvas --anchors=canvas-object
node ace make:collab-document lessons/recording --spaces=video,transcript --anchors=timestamp,text-range

Anchor kinds are validated against the three the library supports; an unknown one fails the command rather than generating a type nothing can satisfy. Spaces are free-form.

The result lands at app/collaboration/documents/<name>_types.ts:

import type { CommentAnchor } from '@adonis-agora/collaboration'

/** Anchor kinds accepted by this document. */
export type WritingAnchor = Extract<CommentAnchor, { kind: 'text-range' }>

/** Document spaces (e.g. main text, canvas, media). */
export type WritingSpace = 'text'

export interface WritingCollabDocument {
  readonly docName: string
  readonly engine: string
}

export const WritingDocument: WritingCollabDocument = {
  docName: 'researches/writing',
  engine: 'yjs',
}

export default WritingDocument

Three things to notice:

• WritingSpace is a union, not a string. Pass it to useComments({ space }) and a typo stops compiling.
• WritingAnchor is narrowed from the library's union, so a canvas document cannot accidentally be handed a text-range anchor.
• The file is importable from the frontend. Everything in it is a type or a constant — no server imports, so a React component can share exactly the same definitions the backend uses.

The _types suffix is the convention the registry generator strips to derive the document name, so keep it.