Igor CLI

Igor CLI is a code scaffolding tool for the Raketa Admin framework. Its goal is to automate starting a new project or a CRUD module.

How to use?

npx @raketa-cloud/igor generate

Commands

npx @raketa-cloud/igor generate

This command generates a new CRUD module. It will ask you for the type of module and about specifics for naming and routing it into the admin.

Available generators:

• collection: Scaffolds a basic CRUD for web resources with IDs
• member: Scaffolds a basic form for web resources without IDs
• editorial: Scaffolds full-featured suite of modules for managing editorial-based workflows (including revisions, page retirement, change URL and so on)

Roadmap

• [x] generate code
• [ ] project init (to replace the process of manually copying CMS Starter)
• [ ] adapt code (for cases when we want to use the whole module but change or extend a bunch of fields)

Local development

Clone the repo and install the latest Node version in .tools-version. Then you can point npx to the path of the package instead of the published version:

npx /path/to/igor-cli generate

Publishing a release

1. Update the version in package.json
2. Create a new release on GitHub - tag it and add human-readable description of what's new in this version
3. An automated GitHub Action triggers and publishes the package to the NPM registry (the NPM access token expires every 90 days)