Skip to content

docs: document the Deno install path for the CLI #3569

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kojiwakayama merged 1 commit into from
Aug 11, 2026
Merged

docs: document the Deno install path for the CLI #3569

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions docs/getting-started/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,10 @@ yarn create veryfront
bun create veryfront
```

```bash deno
deno init --npm veryfront
```

</CodeGroup>

## Install the CLI
Expand Down Expand Up @@ -94,6 +98,18 @@ yarn global add veryfront
bun add -g veryfront
```

### deno
Comment thread
kojiwakayama marked this conversation as resolved.
Comment thread
coderabbitai[bot] marked this conversation as resolved.

```bash
deno install -gArf npm:veryfront
```

The CLI is published to npm only, so install it through Deno's `npm:`
specifier. Deno resolves that specifier from the current working directory, so
inside a project that depends on `veryfront` the global binary runs that
project's version instead. Run `veryfront --version` outside any project
directory to see the globally installed version.

## One-shot CLI usage

Use `npx` when you do not want a global install:
Expand Down
16 changes: 16 additions & 0 deletions tests/docs/guide-content.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -436,6 +436,22 @@ describe("guide content contracts", () => {
);
}
});

it("gives Deno an install path on every surface the installation guide offers", async () => {
const installation = await Deno.readTextFile(
"docs/getting-started/installation.md",
);

// The page lists Deno as a supported runtime floor, so each install
// surface it documents for npm needs a Deno counterpart that works.
assertStringIncludes(installation, "### deno");
assertStringIncludes(installation, "deno install -gArf npm:veryfront");
assertStringIncludes(installation, "deno init --npm veryfront");

// The CLI is published to npm only. `jsr:@veryfront/veryfront` has never
// existed and resolves to a JSR 404, so it must not be advertised.
assertEquals(installation.includes("jsr:@veryfront/veryfront"), false);
});
});

/**
Expand Down