Frequently Asked Questions

RealmKit is a platform for discovering and sharing AI-optimized project templates. Each "realm" is a complete project template with structured documentation that AI coding assistants can understand and use effectively.

Install globally using npm: `npm install -g @realmkit/cli`. You need Node.js 18+ and npm 8+. See our installation guide for detailed instructions and troubleshooting.

Realms include structured documentation in AI context files that explain the project architecture, features, and patterns. This helps AI assistants understand your codebase and provide better suggestions.

Yes! Most realms are free and open source. Some premium realms may require a subscription, but the vast majority of templates are available at no cost.

Use the CLI command `realmkit create <realm-name> <project-name>`. For example: `realmkit create saas-starter my-app`. This downloads and sets up the complete project template.

Absolutely! Realms are starting points. After creation, the project is yours to modify, extend, and customize however you need. The AI context files help assistants understand your changes.

First, check the realm's requirements (Node.js version, dependencies). Try `realmkit validate` to check for issues. If problems persist, report them on the realm's repository or contact the author.

Realms are templates, not frameworks. Updates depend on the specific project structure. Some realms include update scripts, while others require manual updates. Check the realm's documentation.

Good realms are complete, well-documented, and follow best practices. They should include working features, comprehensive AI context documentation, clear setup instructions, and examples.

First, ensure your realm meets quality standards with `realmkit validate`. Then authenticate with `realmkit auth login` and publish with `realmkit publish`. Your realm will be reviewed before going live.

Yes! RealmKit supports public, unlisted, and private visibility options. Private realms are available with premium accounts and can be shared with specific teams or organizations.

Choose a license that fits your needs. MIT and Apache 2.0 are popular for open source realms. For proprietary templates, consider restricting commercial use. Always include a LICENSE file.

Yes! The RealmKit API allows you to list realms, get metadata, and integrate with your own tools. Most endpoints are public, but some features require authentication.

Sign in to your RealmKit account and go to Settings > API Keys. Generate a new key and use it in the Authorization header: `Bearer your-api-key`.

Yes. Anonymous requests are limited to 100/hour, authenticated requests to 1000/hour, and premium users get 5000/hour. Upload operations have stricter limits.

Absolutely! The CLI and API are perfect for automation. Use API keys for authentication and integrate realm creation into your deployment pipelines.

This usually means the CLI isn't in your PATH. Try restarting your terminal, or use `npx @realmkit/cli` instead. On some systems, you may need to add npm's global bin directory to PATH.

Use `sudo npm install -g @realmkit/cli` on macOS/Linux, or run terminal as Administrator on Windows. Alternatively, use a Node version manager like nvm to avoid permission issues.

Check your internet connection, verify the realm name with `realmkit list`, and ensure you have write permissions in the target directory. Use `realmkit create --verbose` for detailed logs.

New realms go through a review process that can take 1-3 business days. Ensure your realm meets quality standards and check for any issues flagged during validation.