Publishing guide

Publishing to Nuclexa takes minutes. You can publish from the web at /publish or from the CLI.

1. Scaffold the package

npx nuclexa init my-agent

This generates agent.json, README.md, instructions.md, and an examples/ directory. See the Package format.

2. Fill in the manifest

Edit agent.json with your identity, type, target platforms, and permission scope — see the agent.json manifest.

{
  "name": "my-agent",
  "displayName": "My Agent",
  "version": "0.1.0",
  "type": "agent",
  "description": "One line describing what this does.",
  "platforms": ["claude-code", "cursor"],
  "permissions": { "readFiles": true },
  "entry": "instructions.md",
  "license": "MIT"
}

3. Write the content

• `instructions.md` — the content the tool loads. Keep it focused and self-contained.
• `README.md` — the overview shown on your package page.
• `examples/` — at least one realistic example prompt. Packages with examples convert far better.

4. Validate locally

npx nuclexa validate

This checks the manifest schema, confirms the entry file exists, and reports the computed risk level.

5. Publish

npx nuclexa login
npx nuclexa publish

The registry rejects the publish if version is not greater than the latest published version, so bump it on every release.

6. Iterate with versions

Checklist before you ship

• [x] agent.json validates and declares the minimal permission scope
• [x] README.md clearly explains the package
• [x] At least one example in examples/
• [x] version bumped from the last release
• [x] License set appropriately

Ready? Head to /publish, or run npx nuclexa publish. Want the trust badge? See Security review.