Skip to content

feat(cli): add custom dashboard port option#357

Merged
jamescmartinez merged 3 commits intoopenworkflowdev:mainfrom
srpvpn:issue/356-custom-port-for-dashboard-view
Mar 4, 2026
Merged

feat(cli): add custom dashboard port option#357
jamescmartinez merged 3 commits intoopenworkflowdev:mainfrom
srpvpn:issue/356-custom-port-for-dashboard-view

Conversation

@srpvpn
Copy link
Contributor

@srpvpn srpvpn commented Mar 2, 2026

Closes #356

Changes

  1. Added a .changeset file documenting the change
  2. Modified cli.ts to add the -p, --port <number> option to the dashboard command
  3. Refactored commands.ts to:
    • Extract spawn configuration logic into getDashboardSpawnOptions()
    • Add validateDashboardPort() for port validation
    • Update dashboard() to use the new functions and accept DashboardOptions
  4. Added comprehensive tests for both new functions
  5. Updated documentation in cli.mdx and dashboard.mdx

@srpvpn
Copy link
Contributor Author

srpvpn commented Mar 3, 2026

I see that the checks have fallen, Im going to fix them within a day

Copy link
Contributor

@jamescmartinez jamescmartinez 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 the PR! I added two suggestions. Once CI passes I'll do another review and merge it.

</CodeGroup>

This launches the OpenWorkflow dashboard on `http://localhost:3000`. See
Use `--port` to run the dashboard on a custom port:
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Use `--port` to run the dashboard on a custom port:
The dashboard starts on `http://localhost:3000` by default.
To use a custom port:

Comment on lines 144 to 146
Without `--port`, this launches the OpenWorkflow dashboard on
`http://localhost:3000`. See
[Dashboard](/docs/dashboard) for details.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Without `--port`, this launches the OpenWorkflow dashboard on
`http://localhost:3000`. See
[Dashboard](/docs/dashboard) for details.
See [Dashboard](/docs/dashboard) for details.

@srpvpn
Copy link
Contributor Author

srpvpn commented Mar 4, 2026

@jamescmartinez Everything should be OK now

@pkg-pr-new
Copy link

pkg-pr-new bot commented Mar 4, 2026

Open in StackBlitz

npm i https://pkg.pr.new/openworkflowdev/openworkflow/@openworkflow/cli@357
npm i https://pkg.pr.new/openworkflowdev/openworkflow/@openworkflow/dashboard@357
npm i https://pkg.pr.new/openworkflowdev/openworkflow@357

commit: 84be94f

@jamescmartinez jamescmartinez merged commit cec5f93 into openworkflowdev:main Mar 4, 2026
4 checks passed
@jamescmartinez
Copy link
Contributor

thanks, merged!

@codecov
Copy link

codecov bot commented Mar 4, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

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.

Custom port for dashboard view

2 participants