Skip to content

[Docs] Specify INSTANT_CLI_DASH_URI - #2812

Merged
nezaj merged 2 commits into
mainfrom
add-dash-uri
Jul 31, 2026
Merged

[Docs] Specify INSTANT_CLI_DASH_URI#2812
nezaj merged 2 commits into
mainfrom
add-dash-uri

Conversation

@nezaj

@nezaj nezaj commented Jul 31, 2026

Copy link
Copy Markdown
Contributor

When using the CLI with self hosted you also need to specify INSTANT_CLI_DASH_URI otherwise you won't connect to the right dashboard to authenticate.

This updates the docs and also updates so our instant.config.ts can accept this param too

CleanShot 2026-07-30 at 17 19 20@2x

@coderabbitai

coderabbitai Bot commented Jul 31, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro Plus

Run ID: c9d2a045-9339-451b-912e-c505613cb0a2

📥 Commits

Reviewing files that changed from the base of the PR and between a15eb18 and 84bd280.

📒 Files selected for processing (4)
  • client/packages/cli/src/lib/http.ts
  • client/packages/cli/src/util/instantConfig.ts
  • client/packages/version/src/version.ts
  • client/www/app/docs/self-hosting/page.md

📝 Walkthrough

Walkthrough

The CLI now supports configuring a custom dashboard URI, validates configured dashboard URLs, preserves environment overrides, and documents dashboard and API URI settings for self-hosted deployments. The shared package version is updated to v1.0.56.

Changes

Dashboard URI Configuration

Layer / File(s) Summary
Configure and resolve dashboard URLs
client/packages/cli/src/util/instantConfig.ts, client/packages/cli/src/lib/http.ts, client/www/app/docs/self-hosting/page.md
InstantConfig supports dashURI; getDashUrl validates and uses it when no environment override is set, then falls back to development or production defaults. Self-hosting documentation covers both API and dashboard URI configuration.

Package Version Update

Layer / File(s) Summary
Update shared package version
client/packages/version/src/version.ts
The shared version changes from v1.0.55 to v1.0.56.

Estimated code review effort: 2 (Simple) | ~10 minutes

Possibly related PRs

Suggested reviewers: drew-harris, stopachka

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly identifies the main documentation change to specify INSTANT_CLI_DASH_URI for self-hosted CLI usage.
Description check ✅ Passed The description accurately explains the required dashboard URI and the related instant.config.ts support.
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 docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch add-dash-uri

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.

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

SGTM!

@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 `@client/packages/cli/src/lib/http.ts`:
- Around line 170-176: Update the environment override branch in the HTTP
configuration flow to validate setEnv.value with the same HttpUrl schema used
for the config-file value before returning it. Map validation failures to
BadArgsError consistently with the existing configuration path, and only return
the validated URI.

In `@client/www/app/docs/self-hosting/page.md`:
- Around line 175-185: Split the combined shell example into separate
copy-enabled blocks for the Local Machine Deployment and Server Deployment
commands, keeping each block’s corresponding environment variables and npx
instant-cli@latest init command together.
🪄 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: Repository UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 05a29969-365b-4c45-a896-8054ea1c53c1

📥 Commits

Reviewing files that changed from the base of the PR and between f48a776 and a15eb18.

📒 Files selected for processing (3)
  • client/packages/cli/src/lib/http.ts
  • client/packages/cli/src/util/instantConfig.ts
  • client/www/app/docs/self-hosting/page.md

Comment thread client/packages/cli/src/lib/http.ts
Comment thread client/www/app/docs/self-hosting/page.md
@github-actions

Copy link
Copy Markdown
Contributor

View Vercel preview at instant-www-js-add-dash-uri-jsv.vercel.app.

@nezaj
nezaj merged commit ab9d690 into main Jul 31, 2026
30 checks passed
@nezaj
nezaj deleted the add-dash-uri branch July 31, 2026 00:29
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