Skip to content

CLI Fix done story#954

Merged
yamcodes merged 3 commits into
mainfrom
cli-fix-done-story
May 12, 2026
Merged

CLI Fix done story#954
yamcodes merged 3 commits into
mainfrom
cli-fix-done-story

Conversation

@yamcodes

@yamcodes yamcodes commented May 12, 2026

Copy link
Copy Markdown
Owner

Summary by CodeRabbit

  • Documentation
    • Enhanced post-scaffolding guidance messages with clearer next steps
    • Improved clarity distinguishing between local scaffolding and AI-powered refinement options
    • Better organized instructions for configuring and using ArkEnv

Review Change Stack

@yamcodes yamcodes added the @arkenv/cli Issues or Pull Requests involving the ArkEnv CLI label May 12, 2026
@changeset-bot

changeset-bot Bot commented May 12, 2026

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 4fa90ff

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@arkenv/cli Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@coderabbitai

coderabbitai Bot commented May 12, 2026

Copy link
Copy Markdown
Contributor

Walkthrough

This PR enhances the ArkEnv CLI's post-scaffolding user experience by adding a conditional logging method to the Logger class and refactoring init command messaging to use multi-line dedent formatting. The changeset documents the patch release with improved guidance text distinguishing local scaffolding from AI refinement.

Changes

CLI messaging and logger enhancements

Layer / File(s) Summary
Logger note method addition
packages/cli/src/lib/logger.ts
The Logger class imports the note helper from @clack/prompts and adds a note(message, title?) method that conditionally renders output as dim-formatted text in quiet/JSON modes or delegates to the prompt helper in interactive mode.
Init command messaging updates
packages/cli/src/commands/init.ts
InitCommand imports dedent and refactors the "Next steps" guidance text to use logger.note with multi-line dedent templates, improving content and presentation for both skill-installed and skill-not-installed cases; the final completion message is also reformatted to multi-line style.
Release documentation
.changeset/great-deer-check.md
Changeset file documents a patch release for @arkenv/cli with new "done" message documentation that clarifies next steps by distinguishing local scaffolding from AI-powered refinement and includes explicit follow-up instructions.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Possibly related PRs

  • yamcodes/arkenv#944: Both PRs modify the CLI's post-scaffolding "next steps" messaging; this PR adds logger-based note rendering while #944 makes the install command package-manager-aware.

Suggested labels

enhancement

Poem

🐰 A note for every step you take,
Multi-line messages now look great,
The logger learns to dedent clean,
Prettiest CLI I've ever seen! ✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'CLI Fix done story' directly relates to the main change: improving the 'done' message text and post-scaffolding guidance in the CLI's init command, as confirmed by commit messages and changeset documentation.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch cli-fix-done-story

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.

@pkg-pr-new

pkg-pr-new Bot commented May 12, 2026

Copy link
Copy Markdown

Open in StackBlitz

arkenv

npm i https://pkg.pr.new/arkenv@954

@arkenv/bun-plugin

npm i https://pkg.pr.new/@arkenv/bun-plugin@954

@arkenv/cli

npm i https://pkg.pr.new/@arkenv/cli@954

@arkenv/fumadocs-ui

npm i https://pkg.pr.new/@arkenv/fumadocs-ui@954

@arkenv/vite-plugin

npm i https://pkg.pr.new/@arkenv/vite-plugin@954

commit: 4fa90ff

@arkenv-bot

arkenv-bot Bot commented May 12, 2026

Copy link
Copy Markdown
Contributor

📦 Bundle Size Report

No results found

All size limits passed!

@yamcodes

Copy link
Copy Markdown
Owner Author

Of course this needs a changeset.

@yamcodes
yamcodes marked this pull request as ready for review May 12, 2026 14:14
@github-actions github-actions Bot added the docs Adds or changes documentation, or acts as documentation in and of itself label May 12, 2026
@arkenv-bot

arkenv-bot Bot commented May 12, 2026

Copy link
Copy Markdown
Contributor

🤖 Hi @yamcodes, I've received your request, and I'm working on it now! You can track my progress in the logs for more details.

@arkenv-bot

arkenv-bot Bot commented May 12, 2026

Copy link
Copy Markdown
Contributor

🤖 I'm sorry @yamcodes, but I was unable to process your request. Please see the logs for more details.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In @.changeset/great-deer-check.md:
- Around line 9-21: The fenced code block that contains the "Next steps" ASCII
art is missing a language identifier which triggers markdownlint MD040; fix this
by changing the opening fence from ``` to ```text so the block is labeled as
plain text (the block that starts with the "Next steps" header and ends with
"ArkEnv scaffolding complete. Happy coding!").
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 0c9d372a-87e3-4932-aae2-23d47334751a

📥 Commits

Reviewing files that changed from the base of the PR and between f736591 and 4fa90ff.

📒 Files selected for processing (3)
  • .changeset/great-deer-check.md
  • packages/cli/src/commands/init.ts
  • packages/cli/src/lib/logger.ts

Comment on lines +9 to +21
```
1 │
2 ◇ Next steps ─────────────────────────────────────────────────────────────────╮
3 │ │
4 │ 1. Check ./src/env.ts and refine your environment schema. │
5 │ 2. Import and use: import { env } from "./src/env" │
6 │ 3. (Recommended) Install the AI skill: pnpm dlx skills add yamcodes/arkenv │
7 │ Then run /arkenv inside your AI assistant to finish. │
8 │ │
9 ├──────────────────────────────────────────────────────────────────────────────╯
10 │
11 └ ⛯ ArkEnv scaffolding complete. Happy coding!
```

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Add a language identifier to the fenced code block.

Line 9 uses an unlabeled fence, which triggers markdownlint MD040.

Proposed fix
-```
+```text
     1 │
     2 ◇  Next steps ─────────────────────────────────────────────────────────────────╮
     3 │                                                                              │
@@
    11 └  ⛯ ArkEnv scaffolding complete. Happy coding!
-```
+```
🧰 Tools
🪛 markdownlint-cli2 (0.22.1)

[warning] 9-9: Fenced code blocks should have a language specified

(MD040, fenced-code-language)

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In @.changeset/great-deer-check.md around lines 9 - 21, The fenced code block
that contains the "Next steps" ASCII art is missing a language identifier which
triggers markdownlint MD040; fix this by changing the opening fence from ``` to
```text so the block is labeled as plain text (the block that starts with the
"Next steps" header and ends with "ArkEnv scaffolding complete. Happy coding!").

@yamcodes
yamcodes merged commit fe10ef4 into main May 12, 2026
39 of 40 checks passed
@yamcodes
yamcodes deleted the cli-fix-done-story branch May 12, 2026 14:17
@arkenv-bot

arkenv-bot Bot commented May 12, 2026

Copy link
Copy Markdown
Contributor

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Review Updated (Asia/Almaty)
arkenv Ready Ready Preview, Comment May 12 2026, 7:17 PM (Asia/Almaty)

@arkenv-bot arkenv-bot Bot mentioned this pull request May 12, 2026
yamcodes pushed a commit that referenced this pull request May 12, 2026
This PR was opened by the [Changesets
release](https://github.com/changesets/action) GitHub action. When
you're ready to do a release, you can merge this and the packages will
be published to npm automatically. If you're not ready to do a release
yet, that's fine, whenever you add more changesets to main, this PR will
be updated.


# Releases
## @arkenv/cli@0.0.5

### Patch Changes

- #### Add agent skill support
_[`#945`](#945)
[`63d6237`](63d6237)
[@yamcodes](https://github.com/yamcodes)_

The CLI now has a new `--agent` flag that lets the ArkEnv agent skill
interact with it in a token-sensitive way. The skill has been updated to
support this new mode.

Also, the CLI will now suggest to install the agent skill for you when
in non-`--agent` mode.

    Read more in the [ArkEnv CLI docs](https://arkenv.js.org/docs/cli).

- #### Improve "done" message text
_[`#954`](#954)
[`fe10ef4`](fe10ef4)
[@yamcodes](https://github.com/yamcodes)_

The output now clearly distinguishes between the local scaffolding and
the AI-powered refinement:

            1 │
2 ◇ Next steps
─────────────────────────────────────────────────────────────────╮
3 │ │
4 │ 1. Check ./src/env.ts and refine your environment schema. │
5 │ 2. Import and use: import { env } from "./src/env" │
6 │ 3. (Recommended) Install the AI skill: pnpm dlx skills add
yamcodes/arkenv │
7 │ Then run /arkenv inside your AI assistant to finish. │
8 │ │
9
├──────────────────────────────────────────────────────────────────────────────╯
           10 │
           11 └  ⛯ ArkEnv scaffolding complete. Happy coding!

- #### Install framework plugins
_[`#948`](#948)
[`1dca74c`](1dca74c)
[@yamcodes](https://github.com/yamcodes)_

The ArkEnv CLI now installs framework plugins as part of the scaffolding
process if a relevant runtime/framework is selected.

- #### Passthrough `--yes` and `--quiet` to underlying process
_[`#952`](#952)
[`10cbb7d`](10cbb7d)
[@yamcodes](https://github.com/yamcodes)_

The ArkEnv CLI will now pass the flags `--yes` and `--quiet` to
underlying processes.

    This means that if you run:

    ```sh
    pnx @arkenv/cli init --yes
    ```

It would now use the recommended settings and avoid prompts even in
sub-processes like the Vercel Skills process to add the ArkEnv skill.

    Similarly, if you run:

    ```sh
    pnx @arkenv/cli init --quiet
    ```

You will not be exposed to the underlying Vercel Skills output, except
for errors which are buffered in memory. (Resolves on exit code 0,
discarding buffered output on success)

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

@arkenv/cli Issues or Pull Requests involving the ArkEnv CLI docs Adds or changes documentation, or acts as documentation in and of itself

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant