dev-domains CLI reference

Part of the dev-domains documentation. See the guide for installation, configuration, and examples.

Generated from the CLI’s command and argument definitions. These commands run in a terminal, not in this page.

run

Run a detected or configured server through Portless

npx @buildkitgg/dev-domains run --help

Argument	Type	Required	Default	Description
--cwd	string	No	"."	Project directory
--config	string	No	—	Explicit config file (relative to cwd)
endpoint	positional	No	—	Endpoint name

init

Detect tools and save project configuration

npx @buildkitgg/dev-domains init --help

Argument	Type	Required	Default	Description
--cwd	string	No	"."	Project directory
--yes	boolean	No	—	Accept detected defaults without prompts
--domain	string	No	—	Local domain suffix
--project	string	No	—	Project name
--dry-run	boolean	No	—	Print the config without writing files

detect

Print detected defaults without reading executable config

npx @buildkitgg/dev-domains detect --help

Argument	Type	Required	Default	Description
--cwd	string	No	"."	Project directory

urls

Print domains and callback URLs as JSON

npx @buildkitgg/dev-domains urls --help

Argument	Type	Required	Default	Description
--cwd	string	No	"."	Project directory
--config	string	No	—	Explicit config file (relative to cwd)

setup

Start Portless with the project's proxy settings

npx @buildkitgg/dev-domains setup --help

Argument	Type	Required	Default	Description
--cwd	string	No	"."	Project directory
--config	string	No	—	Explicit config file (relative to cwd)

status

Show active Portless routes

npx @buildkitgg/dev-domains status --help

Argument	Type	Required	Default	Description
--cwd	string	No	"."	Project directory
--config	string	No	—	Explicit config file (relative to cwd)

doctor

Check Portless, DNS, and certificate trust

npx @buildkitgg/dev-domains doctor --help

Argument	Type	Required	Default	Description
--cwd	string	No	"."	Project directory
--config	string	No	—	Explicit config file (relative to cwd)

tunnel

Expose configured webhook POST paths through a tunnel

npx @buildkitgg/dev-domains tunnel --help

Argument	Type	Required	Default	Description
--cwd	string	No	"."	Project directory
--config	string	No	—	Explicit config file (relative to cwd)
endpoint	positional	No	—	Endpoint name

schema

Print the JSON Schema for editor configuration

npx @buildkitgg/dev-domains schema --help

No command-specific arguments.