> ## Documentation Index
> Fetch the complete documentation index at: https://domoinc-openapi-sync-dataflows.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Setup and Installation

### Step 1: Install the Domo Apps CLI

***

The [Domo Apps CLI](/portal/Apps/App-Framework/Tools/domo-CLI) is the command line tool you can use to authenticate against your Domo Instance and publish your apps there.

<Tabs>
  <Tab title="npm">
    The DomoApps CLI is now distributed **only** through npm (Node Package Manager). Homebrew and Chocolatey are no longer supported and will not receive updates.\
    If you have previously installed the DomoApps CLI using Homebrew or Chocolatey, please uninstall those versions before installing via npm.

    To install the CLI, run the following command from your terminal:

    ```text theme={"dark"}
    npm install -g ryuu
    ```

    Confirm that `domo` has been installed successfully by running `domo --version` from the terminal. If a version number is returned then you have successfully installed the CLI.
  </Tab>

  <Tab title="Mac OSX / Linux">
    <Danger>
      Notice: As of June 18th, 2025, the Homebrew installation method is no longer
      supported. Please use the npm installation method in the "npm" tab above. If
      you previously installed the CLI with Homebrew, uninstall it with:
    </Danger>

    ```text theme={"dark"}
    brew uninstall domo
    ```

    Then, install using npm as shown in the npm tab.
  </Tab>

  <Tab title="Windows">
    <Danger>
      Notice: As of June 18th, 2025, the Chocolatey installation method is no longer
      supported. Please use the npm installation method in the "npm" tab above.
    </Danger>

    If you previously installed the CLI with Chocolatey, uninstall it with:

    ```
    choco uninstall domo
    ```

    Then, install using npm as shown in the npm tab.
  </Tab>
</Tabs>

### Step 2: Login to your Domo Instance

***

From your command-line, run `domo login` and then select `new instance`.

Enter your assigned instance URL and then press enter. You'll then be presented with a login screen and the Domo CLI will be authorized on your instance.

**Connecting Through a Proxy**

If your organization has a firewall set up that blocks you from hitting Domo endpoints, you'll need to work with your network administrators to use the Domo Apps CLI with a proxy server. Otherwise, you can skip this step.

Set the CLI to route requests through your proxy with the following command:

```text theme={"dark"}
domo proxy <Proxy server name> <Port number>
```

Note: if your proxy requires an authentication step, you can add the `-a` flag (`domo proxy -a`), which will ask for your proxy username and will then also require the proxy password on all subsequent `domo` apps cli commands.

### Step 3: Create a New App

***

Run the following commands from your command line to set up a new Domo App project.

```text theme={"dark"}
domo init
```

### Step 4: Leverage Domo App Platform APIs in your Web Application

***

You can now easily integrate Domo APIs into any front-end web application. See [Tutorials](/portal/Apps/App-Framework/Tutorials/Overview) or [API Reference](/portal/API-Reference/app-framework-apis/AppDB-API) for code examples. If you don’t have a pre-existing web application, in addition to the simple `domo init` templates, we have a number of [Starter Kits](/portal/Apps/App-Framework/Quickstart/Starter-Kits) you can use to get up and running quickly whether you prefer React, Angular, or Vue for front-end development.

### Step 5: Publish App to Domo Instance

***

We publish our final product to Domo using

```text theme={"dark"}
domo publish
```

Once your app is deployed as a card, you can share it like you would any other content in Domo.