Skip to content

Docs: add deno install instructions#1079

Open
Ardakilic wants to merge 4 commits into
Fission-AI:mainfrom
Ardakilic:docs/deno
Open

Docs: add deno install instructions#1079
Ardakilic wants to merge 4 commits into
Fission-AI:mainfrom
Ardakilic:docs/deno

Conversation

@Ardakilic
Copy link
Copy Markdown

@Ardakilic Ardakilic commented May 11, 2026

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
    • Added a Deno installation subsection explaining potential issues with parsing floating version tags, recommending explicitly versioned installs, and providing global install examples with required permission flags; notes that additional runtime permissions may be needed for subcommands.

Review Change Stack

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

coderabbitai Bot commented May 11, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 1deee401-2c36-4468-94c7-87f94c459a0d

📥 Commits

Reviewing files that changed from the base of the PR and between c8ae0cc and 5fbe6d5.

📒 Files selected for processing (1)
  • docs/installation.md
✅ Files skipped from review due to trivial changes (1)
  • docs/installation.md

📝 Walkthrough

Walkthrough

Adds a Deno subsection to Package Managers in installation docs, noting possible @latest parsing issues and providing example deno install --global commands (both @latest and pinned @^1.3.1) plus a note about --allow-run for subcommands.

Changes

Deno Installation Documentation

Layer / File(s) Summary
Deno Installation Section
docs/installation.md
New Deno subsection under Package Managers with guidance about potential @latest parsing issues and example deno install --global --allow-* commands using npm:@fission-ai/openspec@latest and npm:@fission-ai/openspec@^1.3.1, and a note about --allow-run for external subcommands.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Suggested reviewers

  • alfred-openspec

Poem

🐰 A Deno note in shining text,
Pin the version if @latest perplex,
Grant the flags and run with care,
Small commands hop through open air,
Docs now guide the installer’s trek.

🚥 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 'Docs: add deno install instructions' accurately and clearly describes the main change: adding Deno installation documentation to the docs folder.
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 unit tests (beta)
  • Create PR with unit tests

Tip

💬 Introducing Slack Agent: The best way for teams to turn conversations into code.

Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.

  • Generate code and open pull requests
  • Plan features and break down work
  • Investigate incidents and troubleshoot customer tickets together
  • Automate recurring tasks and respond to alerts with triggers
  • Summarize progress and report instantly

Built for teams:

  • Shared memory across your entire org—no repeating context
  • Per-thread sandboxes to safely plan and execute work
  • Governance built-in—scoped access, auditability, and budget controls

One agent for your entire SDLC. Right inside Slack.

👉 Get started


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.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

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
Copy link
Copy Markdown
Collaborator

@alfred-openspec alfred-openspec left a comment

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
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.

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