CLI
The convilyn-author binary scaffolds, runs, synthesises, and tests a TypeScript tool server.
npx convilyn-author init my-server # scaffold a TS project
cd my-server && npm install && npm run build
npx convilyn-author dev # run the JSON-RPC /mcp server (serve)
npx convilyn-author synth # write convilyn.manifest.json
npx convilyn-author test # local compliance checks (runComplianceChecks)
npx convilyn-author push --endpoint-url https://my-server.example.com # publish to the Developer PortalCommands
| Command | What it does |
|---|---|
init <name> | Scaffold a TypeScript project |
dev | Run the JSON-RPC /mcp server (serve) |
synth | Write convilyn.manifest.json |
test | Run local compliance checks (runComplianceChecks) |
push | Register your tool server with the Developer Portal (BYO hosting) |
deploy --hosted | Provision your server on the managed Convilyn-hosted runtime |
rollback <id> | Roll a hosted runtime back to its previous version |
logs <id> | Fetch recent logs for a hosted runtime |
synth / dev / test load a built JS module (default server.js, override with --file dist/server.js) that exports a ToolServer as its default or a named server export.
npx convilyn-author dev --file dist/server.jspush — publish to the Developer Portal
push registers your tool server with the Developer Portal, wrapping ConvilynClient.submitServer. Workflow authoring lives in the Convilyn chat Builder; the Author SDK is the tool-server SDK. Set a cvl_ developer key in CONVILYN_API_KEY first, then point at your deployed server's HTTPS URL:
export CONVILYN_API_KEY=cvl_your_key
npx convilyn-author push \
--file dist/server.js \
--endpoint-url https://my-server.example.com--endpoint-url(required) — the HTTPS URL where you host the tool server. You deploy it; Convilyn registers and verifies it.--file— the built server module (defaultserver.js).
Where to go next
Author SDK · TypeScriptRuntime
What dev runs: the JSON-RPC /mcp server.
Build the ToolServer the CLI loads.
Register + publish your tool server with ConvilynClient (Developer
Portal).
Back up to the Author SDK landing page.