> ## Documentation Index
> Fetch the complete documentation index at: https://toolkit.astralsolutions.tech/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Started with All-In-One Developer Toolkit in 5 Minutes

> Learn how to inspect ports, clean disk space, set up a local proxy domain, and launch the web dashboard with All-In-One Developer Toolkit in minutes.

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.

<Steps>
  <Step title="Verify your installation">
    Before anything else, confirm that the `toolkit` binary is reachable and on the expected version:

    ```bash theme={null}
    toolkit --version
    ```

    Expected output:

    ```
    0.1.0
    ```

    If you see a version number, you're good to go. If the command isn't found, revisit the [installation guide](installation) to check your `PATH` setup.
  </Step>

  <Step title="Inspect your open ports">
    List every port currently in use on your machine along with the process that owns it:

    ```bash theme={null}
    toolkit ports list
    ```

    Toolkit returns a formatted table similar to the following:

    ```
    PORT    PROTOCOL    PID      PROCESS
    ──────────────────────────────────────────
    3000    TCP         12374    node
    5432    TCP         8801     postgres
    8080    TCP         22103    python
    57341   UDP         1        launchd
    ```

    Use this output to identify which process is blocking a port you need. To kill a blocking process, run `toolkit ports kill <port>`.
  </Step>

  <Step title="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:

    ```bash theme={null}
    toolkit clean scan ~/projects
    ```

    Toolkit walks the directory tree and reports each reclaimable path together with its size on disk:

    ```
    PATH                                        SIZE
    ─────────────────────────────────────────────────────
    ~/projects/my-app/node_modules              842 MB
    ~/projects/api-server/node_modules          310 MB
    ~/projects/ml-model/.venv                   1.2 GB
    ~/projects/old-site/node_modules            204 MB

    Total reclaimable: 2.5 GB
    ```

    When you're ready to free the space, run `toolkit clean purge ~/projects` to delete every listed artifact after a confirmation prompt.
  </Step>

  <Step title="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:

    ```bash theme={null}
    toolkit run my-app npm run dev
    ```

    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:

    ```
    http://my-app.localhost
    ```

    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.
  </Step>

  <Step title="Review your active proxy routes">
    List all currently active proxy routes to see which local apps have `*.localhost` domains assigned:

    ```bash theme={null}
    toolkit proxy list
    ```

    Example output:

    ```
    DOMAIN                  TARGET              STATUS
    ─────────────────────────────────────────────────────
    my-app.localhost        localhost:3000      active
    api.localhost           localhost:4000      active
    toolkit.localhost       localhost:5173      active
    ```

    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.
  </Step>

  <Step title="Open the web dashboard">
    Every feature you've used on the CLI is also available through a browser UI. Start the dashboard with:

    ```bash theme={null}
    toolkit ui
    ```

    Then open your browser and go to:

    ```
    http://toolkit.localhost
    ```

    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.
  </Step>
</Steps>

<Tip>
  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.

  ```bash theme={null}
  toolkit ports list --json
  ```
</Tip>

## What's Next?

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

<CardGroup cols={2}>
  <Card title="Port Management" icon="network-wired" href="features/ports">
    Learn to list, filter, and kill ports — and set up port-conflict alerts for your most-used services.
  </Card>

  <Card title="Disk Cleaner" icon="broom" href="features/cleaner">
    Configure scan targets, exclusion patterns, and scheduled cleanups to keep your disk lean automatically.
  </Card>

  <Card title="Local Reverse Proxy" icon="arrow-right-arrow-left" href="features/proxy">
    Create persistent routes, configure HTTPS for `*.localhost`, and manage proxy rules across projects.
  </Card>

  <Card title="Hosts File Manager" icon="file-lines" href="features/hosts">
    Safely add, toggle, and audit hosts file entries without ever editing the raw system file by hand.
  </Card>
</CardGroup>