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

# Install OpenCompany

> Two commands and about five minutes - no login, no account, everything on your machine

<Info>
  **Takes:** 2-10 minutes, mostly automatic downloads. **You need:** Node.js 22+ and Python 3.12+ (checked below). **Disk:** about 1 GB. No git, no build tools, no account.
</Info>

<Note>
  No command-line experience? You only need to copy and paste three lines into the terminal (the text command app — **Terminal** on macOS, **PowerShell** on Windows). Each step below tells you exactly what you should see.
</Note>

## Before you install

OpenCompany needs two free tools. Check whether you already have them:

<CodeGroup>
  ```powershell Windows theme={null}
  node --version
  ```

  ```bash macOS theme={null}
  node --version
  ```

  ```bash Linux theme={null}
  node --version
  ```
</CodeGroup>

You should see `v22` or higher. Then:

<CodeGroup>
  ```powershell Windows theme={null}
  python --version
  ```

  ```bash macOS theme={null}
  python3 --version
  ```

  ```bash Linux theme={null}
  python3 --version
  ```
</CodeGroup>

You should see `Python 3.12` or higher.

Missing one? Install Node.js from [nodejs.org](https://nodejs.org) (choose the LTS version) and Python from [python.org/downloads](https://www.python.org/downloads/). On Windows, tick **Add python.exe to PATH** in the Python installer. Then open a new terminal window and re-check.

<Tip>
  Everything else — including the uv Python package manager — installs itself automatically.
</Tip>

## Install (3 steps)

<Steps>
  <Step title="Install the app">
    ```bash theme={null}
    npm install -g @zeenie-ai/opencompany
    ```

    Downloads run for a few minutes (Python packages and the workflow engine, \~1 GB total). At the end you should see `Run: company start`.
  </Step>

  <Step title="Start it">
    ```bash theme={null}
    company start
    ```

    You should see:

    ```
    OpenCompany v0.0.96
    App:       http://localhost:5678  (API + WebSocket + SPA)
    ```
  </Step>

  <Step title="Open it">
    Go to [http://localhost:5678](http://localhost:5678) in your browser.
    The workflow canvas appears — no login needed — and the **Welcome Guide** walks you through the basics.
  </Step>
</Steps>

<Check>
  You see the canvas with a component palette on the left and three example workflows in the sidebar. You're in.
</Check>

## One-command installers

Don't want to install Node and Python yourself? These scripts install the prerequisites AND OpenCompany in one go:

<CodeGroup>
  ```powershell Windows theme={null}
  iwr -useb https://raw.githubusercontent.com/zeenie-ai/OpenCompany/main/install.ps1 | iex
  ```

  ```bash macOS theme={null}
  curl -fsSL https://raw.githubusercontent.com/zeenie-ai/OpenCompany/main/install.sh | bash
  ```

  ```bash Linux theme={null}
  curl -fsSL https://raw.githubusercontent.com/zeenie-ai/OpenCompany/main/install.sh | bash
  ```
</CodeGroup>

When the script finishes, run `company start` and open `http://localhost:5678`.

<Accordion title="Windows note: slow first install or startup">
  Windows Defender scans every new Python file, which can make the first install or start slow. If it drags: open **Windows Security** → **Virus & threat protection** → **Manage settings** → **Exclusions**, and add the `server\.venv` folder inside your OpenCompany install. A reboot after first install also helps.
</Accordion>

## Everyday commands

| Command | What it does |
| - | - |
| `company start` | Start everything (production mode) |
| `company stop` | Stop everything |
| `company doctor` | Check system dependencies and project health |
| `company build` | Rebuild after an update |
| `company clean` | Remove build artifacts for a fresh rebuild |
| `company deploy up/status/destroy` | Put OpenCompany on a cloud server ([guide](/deployment/production)) |
| `company version` | Show the installed version |

<Note>
  The old `machina` command still works as a deprecated alias of `company`.
</Note>

## Settings you might change later

OpenCompany creates its settings file (`.env`) automatically — you do not need to touch it to get started. Two settings people ask about:

<AccordionGroup>
  <Accordion title="Ports">
    The app runs on a single port, 5678 (backend and browser UI together), with the other services on the ports right after it (5679-5683). If another program owns one, edit the `.env` file inside the install folder and change `PYTHON_BACKEND_PORT` (and friends), then restart.
  </Accordion>

  <Accordion title="Login screen">
    Local installs have no login (`VITE_AUTH_ENABLED=false` by default) — the app is only reachable from your own machine. Cloud deployments created with `company deploy` turn the login gate on automatically. To require a login locally, set `VITE_AUTH_ENABLED=true` in `.env` and restart.
  </Accordion>
</AccordionGroup>

## For developers

<Accordion title="Run from source (contributors)">
  This path needs git and [bun](https://bun.sh) in addition to Node 22+ and Python 3.12+:

  ```bash theme={null}
  git clone https://github.com/zeenie-ai/opencompany.git
  ```

  ```bash theme={null}
  cd opencompany
  ```

  ```bash theme={null}
  npm install -g bun
  ```

  ```bash theme={null}
  bun run build
  ```

  ```bash theme={null}
  bun run dev
  ```

  `bun run dev` starts the hot-reload dev stack (Vite + backend + workflow engine). The package scripts are thin wrappers over the `company` CLI (`python -m cli dev`). The backend environment is managed by [uv](https://docs.astral.sh/uv/) against `server/uv.lock` — `bun run build` sets it up for you (including `bun install`). Handy dev flags: `company dev --force` (re-bundle frontend dependencies) and `company dev --daemon` (expose the backend on your network).
</Accordion>

## If something went wrong

<Card title="Troubleshooting" icon="life-ring" href="/troubleshooting">
  Version checks, port conflicts, Defender slowdowns, and clean rebuilds — with exact commands.
</Card>

## Next step

<Card title="Add your AI key" icon="key" href="/add-api-keys">
  Connect one AI provider (2 minutes) — or run free local models.
</Card>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.