Skip to main content
In the next five minutes you’ll have Toolkit running and experience all four core features hands-on: port inspection, disk cleanup, local reverse proxy routing, and the web dashboard. No prior configuration is needed — everything works out of the box after installation.
1

Verify your installation

Before anything else, confirm that the toolkit binary is reachable and on the expected version:
Expected output:
If you see a version number, you’re good to go. If the command isn’t found, revisit the installation guide to check your PATH setup.
2

Inspect your open ports

List every port currently in use on your machine along with the process that owns it:
Toolkit returns a formatted table similar to the following:
Use this output to identify which process is blocking a port you need. To kill a blocking process, run toolkit ports kill <port>.
3

Check disk usage in your projects folder

Scan a directory for heavyweight development artifacts — node_modules folders, Python virtual environments (venv, .venv), and build output directories:
Toolkit walks the directory tree and reports each reclaimable path together with its size on disk:
When you’re ready to free the space, run toolkit clean purge ~/projects to delete every listed artifact after a confirmation prompt.
4

Start an app with a clean local URL

Launch any local dev server through Toolkit and it automatically receives a *.localhost domain — no hosts file editing required:
Toolkit starts your npm run dev process, detects the port it binds to, and immediately creates a proxy route for it. Open your browser and navigate to:
Your app loads just like it would at localhost:3000, but now with a memorable, readable URL you can share with teammates on the same network.
5

Review your active proxy routes

List all currently active proxy routes to see which local apps have *.localhost domains assigned:
Example output:
Each row shows the friendly domain, the underlying port it proxies to, and whether the route is currently active. Use toolkit proxy remove <domain> to tear down a route you no longer need.
6

Open the web dashboard

Every feature you’ve used on the CLI is also available through a browser UI. Start the dashboard with:
Then open your browser and go to:
From the dashboard you can manage ports, run disk scans, configure proxy routes, and edit hosts file entries — all without leaving the browser. The dashboard stays in sync with the CLI in real time because both interfaces talk to the same background daemon.
Append --json to any Toolkit command to receive structured JSON output instead of the formatted table. This is useful for piping results into other tools, feeding data to AI assistants, or integrating Toolkit into CI scripts.

​
What’s Next?

Dive deeper into each feature to unlock the full power of Toolkit:

Port Management

Learn to list, filter, and kill ports — and set up port-conflict alerts for your most-used services.

Disk Cleaner

Configure scan targets, exclusion patterns, and scheduled cleanups to keep your disk lean automatically.

Local Reverse Proxy

Create persistent routes, configure HTTPS for *.localhost, and manage proxy rules across projects.

Hosts File Manager

Safely add, toggle, and audit hosts file entries without ever editing the raw system file by hand.