feat: add ignite-ui-cli skill and command reference documentation#1521
feat: add ignite-ui-cli skill and command reference documentation#1521Marina-L-Stoyanova wants to merge 7 commits intomasterfrom
Conversation
There was a problem hiding this comment.
Pull request overview
Adds a new Ignite UI CLI “skill” plus a command-reference document intended to guide users on scaffolding, adding templates, serving, building, testing, config, auth template usage, and upgrades.
Changes:
- Added a new Ignite UI CLI skill (
skills/ignite-ui-cli-skill.md) defining rules, workflow, cheat sheet, recovery steps, and examples. - Added a new command reference document (
skills/reference/commands.md) with full syntax, flags, templates, default ports, auth template details, and upgrade notes.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 8 comments.
| File | Description |
|---|---|
| skills/reference/commands.md | New command reference for ig CLI usage, flags, ports, templates, auth template, and upgrades. |
| skills/ignite-ui-cli-skill.md | New “skill” behavioral guide for using the Ignite UI CLI, referencing the command reference doc. |
Comments suppressed due to low confidence (1)
skills/ignite-ui-cli-skill.md:62
- This row hardcodes a specific port (
4201) as the suggested fix, which conflicts with the earlier “Never hardcode ports” rule and may not be appropriate for non-Angular projects. Consider using a placeholder (e.g.,--port=<freePort>) or instructing the user to pick an unused port instead of suggesting a specific number.
| 403/404 on build | Missing Infragistics licensed account | Log in or switch to OSS packages |
| Port already in use | Conflict on default port | `ig start --port=4201` |
| Prompts don't render | Unsupported terminal (Inquirer.js) | Use Windows Terminal, iTerm2, or VS Code terminal |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
|
@Marina-L-Stoyanova I've opened a new pull request, #1522, to work on those changes. Once the pull request is ready, I'll request review from you. |
…/igniteui-cli into mstoyanova/adding-skill
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 2 out of 2 changed files in this pull request and generated 6 comments.
Comments suppressed due to low confidence (1)
skills/ignite-ui-cli-skill.md:62
- Non‑negotiable rule #4 says “Never hardcode ports”, but the error-recovery table suggests a specific port (
ig start --port=4201). This is inconsistent guidance; consider rephrasing to “pick an available port” (or show a placeholder) to align with the rule.
| 403/404 on build | Missing Infragistics licensed account | Log in or switch to OSS packages |
| Port already in use | Conflict on default port | `ig start --port=4201` |
| Prompts don't render | Unsupported terminal (Inquirer.js) | Use Windows Terminal, iTerm2, or VS Code terminal |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| |---------|-------------|-----| | ||
| | `ig add` does nothing | Not inside a project folder | `cd` into the project root | | ||
| | Component missing from nav | `--skip-route` was used | Manually add route to `app-routing.module.ts` | | ||
| | 403/404 on build | Missing Infragistics licensed account | Log in or switch to OSS packages | |
There was a problem hiding this comment.
Not bad to have some guidance how switching to OSS packages is done and how to setup the licence, if user have valid license
| | Angular | `ig-ts` | Ignite UI Angular JS Wrappers | | ||
| | React | `igr-es6` | Ignite UI for React (native components) | | ||
| | React | `ig-ts` | Ignite UI jQuery React Wrappers | | ||
| | jQuery | `js` | Default — `--type` not required | |
There was a problem hiding this comment.
I think that webComponents should be listed in frameworks and also in the end of the skills in part with examples as there is article in web components documentation about cli: https://www.infragistics.com/products/ignite-ui-web-components/web-components/components/general-cli-overview
Closes # .
Additional information related to this pull request: