Skip to content

Docs: add deno install instructions - #1079

Merged
alfred-openspec merged 10 commits into
Fission-AI:mainfrom
Ardakilic:docs/deno
Jul 30, 2026
Merged

Docs: add deno install instructions#1079
alfred-openspec merged 10 commits into
Fission-AI:mainfrom
Ardakilic:docs/deno

Conversation

@Ardakilic

@Ardakilic Ardakilic commented May 11, 2026

Copy link
Copy Markdown
Contributor

This PR introduces deno install instructions for OpenSpec.

I've tried already and I've been using without issues.

I've also added a small notice for @latest tag parsing.

Thanks!

Summary by CodeRabbit

  • Documentation
    • Updated the installation guide with a new “Install with your AI assistant” section featuring a full step-by-step assistant prompt.
    • Expanded the “Package Managers” guidance, including notes for Yarn 2+ users and added a Deno subsection with recommended explicitly versioned installs, example deno install --global commands, and required --allow-* permissions guidance.
    • Enhanced the “Updating” instructions to clarify that openspec update can check for newer CLI releases and offer upgrades.

@Ardakilic
Ardakilic requested a review from TabishB as a code owner May 11, 2026 01:31
@coderabbitai

coderabbitai Bot commented May 11, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

  • @coderabbitai resume to resume automatic reviews.
  • @coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

  • ▶️ Resume reviews
  • 🔍 Trigger review

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: 3c0cb0b5-edeb-444d-a144-2e4e13e601d4

📥 Commits

Reviewing files that changed from the base of the PR and between a7308cd and d2dfd39.

📒 Files selected for processing (1)
  • docs/installation.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • docs/installation.md

📝 Walkthrough

Walkthrough

Expands installation documentation with an AI assistant setup prompt, Yarn 2+ guidance, Deno installation workarounds and permissions, and openspec update upgrade-check behavior.

Changes

Installation Documentation

Layer / File(s) Summary
AI assistant installation flow
docs/installation.md
Adds a step-by-step prompt covering runtime checks, global CLI installation, PATH verification, tool mapping, project initialization, and final reporting.
Package manager installation guidance
docs/installation.md
Explains the Yarn 2+ global command limitation and adds versioned Deno installation examples with required permissions and --allow-run=<program> guidance.
CLI update behavior
docs/installation.md
Documents that openspec update checks for newer CLI releases and offers upgrades.

Estimated code review effort: 1 (Trivial) | ~3 minutes

Possibly related PRs

Suggested reviewers: tabishb

🚥 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 accurately reflects the main change by adding Deno installation instructions to the docs.
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.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

@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: 2

🤖 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 `@docs/installation.md`:
- Around line 29-30: Rewrite the sentence to improve grammar and clarify the
logic: change "change `@latest` tag with" to "replace the `@latest` tag with", add
"the" before "@latest tag", and make the flow explicit by stating that if Deno
has trouble resolving `@latest` you should instead specify a concrete version (for
example replace the `@latest` tag with a version specifier like @^1.3.1). Ensure
the resulting sentence reads smoothly and unambiguously explains when and how to
use a pinned version.
- Around line 32-36: Replace the overly permissive Deno install commands that
use --allow-all with the minimal required permissions; update the bash snippets
that install npm:`@fission-ai/openspec` (both the `@latest` and @^1.3.1 variants) to
use --allow-read --allow-write --allow-env --allow-net instead of --allow-all so
the installation lines reflect only the actual permissions OpenSpec needs.
🪄 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: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 484f8d20-e2f2-4530-838a-c3e8dd8e98be

📥 Commits

Reviewing files that changed from the base of the PR and between 053d8a5 and b632401.

📒 Files selected for processing (1)
  • docs/installation.md

Comment thread docs/installation.md Outdated
Comment thread docs/installation.md

@alfred-openspec alfred-openspec left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Thanks for adding this. I smoke-tested the Deno path with Deno 2.7.14 in an isolated temp cache. The npm:@fission-ai/openspec@latest and @^1.3.1 specifiers parse and basic OpenSpec commands can run under Deno's Node/npm compatibility, but we should not document --allow-all.

Please switch this to a narrower set, and include --allow-sys=cpus,homedir as well. Without --allow-sys=cpus, even openspec --version fails via fast-glob/os.cpus(), and without homedir, openspec init --tools none fails through config path resolution. A safer default command would be:

deno install --global \
  --allow-read --allow-write --allow-env --allow-sys=cpus,homedir --allow-net=edge.openspec.dev \
  npm:@fission-ai/openspec@latest

I'd also add a short note that subcommands which launch external tools, like config edit, feedback, or workspace open, may need a scoped --allow-run=<program> if users rely on them.

@Ardakilic

Copy link
Copy Markdown
Contributor Author

Thanks for the feedback @alfred-openspec . I considered settings scope one by one, but deno runs the apps sandboxed as default, and since node and bun etc. does not this anyways, and the possibility of future new permissions made me consider adding --allow-all instead.

I've updated due your feedback, and updated my pull request.

@alfred-openspec alfred-openspec left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

The narrower permissions resolve the earlier safety concern, and the documented command successfully installs and runs OpenSpec 1.6.0 under Deno 2.7.14. Good to go from my review.

@Ardakilic

Copy link
Copy Markdown
Contributor Author

Rebased again, and fixed the new emerged conflict. I believe if you're okay the PR is ready to be merged.

@alfred-openspec alfred-openspec left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Re-reviewed the rebased head d2dfd39. The diff is still limited to the Deno installation guidance, both documented specifiers install OpenSpec 1.7.0 successfully under Deno 2.9.4 with the scoped permissions, and the CodeRabbit check is green. Good to merge.

@alfred-openspec
alfred-openspec added this pull request to the merge queue Jul 30, 2026
Merged via the queue into Fission-AI:main with commit 1da6dfa Jul 30, 2026
13 checks passed
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.

3 participants