Skip to content

Conversation

@TabishB
Copy link
Contributor

@TabishB TabishB commented Nov 20, 2025

Summary

  • Adds prominent restart instruction in success message after openspec init
  • Informs users they need to restart their IDE/coding tool for slash commands to appear
  • Applies to all tools when slash commands are created or refreshed
  • Updates cli-init spec to document the restart instruction requirement

Problem

Users don't realize they need to restart their IDE/coding tool after running openspec init for slash commands to appear. This is a common pain point that leads to confusion and support requests.

Solution

Display a clear "Important: Restart your IDE" message in the post-installation output, positioned prominently before the "Next steps" section. The message explains that slash commands are loaded at startup and instructs users to restart their coding assistant.

Changes

  • src/core/init.ts: Added restart instruction block in displaySuccessMessage() method
  • openspec/specs/cli-init/spec.md: Added new scenario documenting restart instruction requirement

Test Plan

Run openspec init, select any tool(s), and verify the restart instruction appears in the success message.

🤖 Generated with Claude Code

Summary by CodeRabbit

  • New Features
    • iFlow CLI initialization now supported with automatic IFLOW.md creation and managed content blocks
    • Slash commands for OpenSpec (/openspec-proposal, /openspec-apply, /openspec-archive) generated for iFlow CLI
    • Restart reminder displayed after tool setup to ensure new slash commands load properly
    • Expanded AI tool support in configuration options

✏️ Tip: You can customize this high-level summary in your review settings.

Add prominent restart instruction in success message to inform users
they need to restart their IDE/coding tool for slash commands to appear.
Applies to all tools when slash commands are created or refreshed.

Also updates cli-init spec to document the restart instruction requirement.
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Nov 20, 2025

Walkthrough

The PR adds iFlow CLI tool support to initialization and update flows with YAML frontmatter slash-command generation, reorders AI tool registry entries, and introduces a restart reminder prompt when tools are created or refreshed.

Changes

Cohort / File(s) Change Summary
CLI Specification Updates
openspec/specs/cli-init/spec.md, openspec/specs/cli-update/spec.md
Adds new scenarios for iFlow CLI configuration and slash-command generation. CLI init now creates IFLOW.md with managed block stubs and generates three slash commands (openspec-proposal.md, openspec-apply.md, openspec-archive.md) with YAML frontmatter. CLI update refreshes iFlow slash commands while preserving YAML metadata. Adds restart instruction scenario after successful initialization.
AI Tool Registry
src/core/config.ts
Reorders and adds entries to AI_TOOLS array: introduces Amazon Q Developer, Antigravity, Codex, GitHub Copilot, OpenCode, RooCode, and Windsurf with updated positioning.
Initialization Flow
src/core/init.ts
Adds user-facing restart reminder output when tools are created or refreshed, informing users to restart their IDE so slash commands appear in the command palette.

Sequence Diagram

sequenceDiagram
    participant User as User
    participant Init as Init Flow
    participant Config as Config
    participant FS as File System

    User->>Init: Run OpenSpec init
    Init->>Config: Get AI tools list
    Config-->>Init: Return updated AI_TOOLS
    User->>Init: Select iFlow CLI
    Init->>FS: Create/update IFLOW.md
    FS-->>Init: ✓ File created
    rect rgba(76, 175, 80, 0.2)
        note right of Init: Generate slash commands
        Init->>FS: Create .iflow/commands/openspec-proposal.md<br/>(with YAML frontmatter)
        Init->>FS: Create .iflow/commands/openspec-apply.md<br/>(with YAML frontmatter)
        Init->>FS: Create .iflow/commands/openspec-archive.md<br/>(with YAML frontmatter)
        FS-->>Init: ✓ Commands generated
    end
    rect rgba(33, 150, 243, 0.2)
        note right of Init: Show restart prompt
        Init->>User: Display restart instruction<br/>(commands loaded at startup)
    end
    Init->>User: Next steps
Loading

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~22 minutes

  • Spec changes introduce new iFlow CLI scenarios requiring consistency verification across init and update flows
  • AI_TOOLS array reordering requires checking for any downstream dependencies or references
  • Init.ts conditional logic for restart reminder should be reviewed for message clarity and placement within output flow

Possibly related PRs

Poem

🐰 iFlow commands now flow with grace,
YAML frontmatter marks each place,
Restart reminders help users see,
Slash commands appear, wild and free!
Tools reordered in config's embrace,

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately reflects the main change: adding an IDE restart instruction after initialization, which is the primary objective and the most user-facing change across modified files.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
  • 📝 Generate docstrings
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch update-docs

📜 Recent review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 19ccaab and fdcf962.

📒 Files selected for processing (4)
  • openspec/specs/cli-init/spec.md (3 hunks)
  • openspec/specs/cli-update/spec.md (1 hunks)
  • src/core/config.ts (1 hunks)
  • src/core/init.ts (1 hunks)
🧰 Additional context used
🧠 Learnings (1)
📚 Learning: 2025-11-17T12:07:21.701Z
Learnt from: ydai-hub
Repo: Fission-AI/OpenSpec PR: 268
File: src/core/configurators/iflow.ts:14-21
Timestamp: 2025-11-17T12:07:21.701Z
Learning: In the OpenSpec repository, `TemplateManager.getClaudeTemplate()` returns a generic template that works for iFlow and other CLI tools, not just Claude-specific content. It's acceptable to use this template across different tool configurators.

Applied to files:

  • openspec/specs/cli-init/spec.md
🧬 Code graph analysis (2)
openspec/specs/cli-update/spec.md (1)
test/core/update.test.ts (1)
  • iflowProposal (667-712)
src/core/init.ts (1)
src/core/styles/palette.ts (1)
  • PALETTE (3-8)
🪛 LanguageTool
openspec/specs/cli-init/spec.md

[style] ~130-~130: Consider using “who” when you are referring to people instead of objects.
Context: ...t steps" section - AND inform users that slash commands are loaded at startup - ...

(THAT_WHO)

🔇 Additional comments (6)
src/core/init.ts (1)

865-879: LGTM! Clear and well-placed restart instruction.

The restart reminder is displayed at the right time (when tools are actually configured) and provides clear, actionable guidance to users. The placement between the tool summary and next steps ensures visibility without disrupting the flow.

openspec/specs/cli-update/spec.md (1)

126-131: LGTM! iFlow CLI scenario is well-specified.

The new scenario follows the established pattern for other tools and correctly documents the expected behavior for updating iFlow CLI slash commands, including frontmatter preservation and managed block updates.

src/core/config.ts (1)

20-39: Verify that tool registry reordering belongs in this PR.

The PR objectives focus on adding restart instructions after init, but this file contains reordering and potential additions to the AI tools registry. These changes aren't mentioned in the PR description or objectives.

Consider whether these tool registry changes should be:

  1. Documented in the PR description if they're intentional
  2. Split into a separate PR if they're unrelated to the restart instruction feature
  3. Reverted if they were accidentally included

The reordering might affect the display order in interactive prompts, so if these changes are intentional, please verify they produce the desired user experience.

openspec/specs/cli-init/spec.md (3)

79-84: LGTM! iFlow CLI configuration scenario is well-documented.

The scenario follows the established pattern for other AI tools and correctly specifies the expected configuration behavior.


127-131: LGTM! Restart instruction scenario directly addresses the PR objective.

This scenario properly documents the restart instruction requirement and aligns perfectly with the implementation in src/core/init.ts (lines 865-879). The specification clearly defines when the instruction should appear and what information it should convey to users.


253-259: LGTM! iFlow CLI slash command generation is well-specified.

The scenario comprehensively documents the expected behavior for iFlow CLI slash command generation, including YAML frontmatter structure, OpenSpec markers, and template requirements. This is consistent with scenarios for other supported tools.

Tip

📝 Customizable high-level summaries are now available in beta!

You can now customize how CodeRabbit generates the high-level summary in your pull requests — including its content, structure, tone, and formatting.

  • Provide your own instructions using the high_level_summary_instructions setting.
  • Format the summary however you like (bullet lists, tables, multi-section layouts, contributor stats, etc.).
  • Use high_level_summary_in_walkthrough to move the summary from the description to the walkthrough section.

Example instruction:

"Divide the high-level summary into five sections:

  1. 📝 Description — Summarize the main change in 50–60 words, explaining what was done.
  2. 📓 References — List relevant issues, discussions, documentation, or related PRs.
  3. 📦 Dependencies & Requirements — Mention any new/updated dependencies, environment variable changes, or configuration updates.
  4. 📊 Contributor Summary — Include a Markdown table showing contributions:
    | Contributor | Lines Added | Lines Removed | Files Changed |
  5. ✔️ Additional Notes — Add any extra reviewer context.
    Keep each section concise (under 200 words) and use bullet or numbered lists for clarity."

Note: This feature is currently in beta for Pro-tier users, and pricing will be announced later.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@TabishB TabishB merged commit 938d03b into main Nov 21, 2025
7 checks passed
Balancor pushed a commit to Balancor/OpenSpec that referenced this pull request Nov 29, 2025
Add prominent restart instruction in success message to inform users
they need to restart their IDE/coding tool for slash commands to appear.
Applies to all tools when slash commands are created or refreshed.

Also updates cli-init spec to document the restart instruction requirement.
fenghaitao pushed a commit to fenghaitao/OpenSpec that referenced this pull request Dec 10, 2025
Add prominent restart instruction in success message to inform users
they need to restart their IDE/coding tool for slash commands to appear.
Applies to all tools when slash commands are created or refreshed.

Also updates cli-init spec to document the restart instruction requirement.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants