# app
URL: https://synquic.tech/docs/cli/reference/app.md

Commands, arguments, and options for synq app.

See the [workflow guide](/docs/cli/projects) for examples. Global flags such as `--json` go before the command; see [global options](/docs/cli/reference#global-options).

## synq app

Browse, install, and configure catalog apps

```text
synq app [options] [command]
```

| Subcommand | Purpose |
| --- | --- |
| [`list\|ls`](/docs/cli/reference/app#synq-app-list) | List available catalog apps |
| [`get <id>`](/docs/cli/reference/app#synq-app-get) | Show an app template and an accessible installation draft |
| [`host-fit [options] <id>`](/docs/cli/reference/app#synq-app-host-fit) | Check an app's requirements against a deployment destination |
| [`install [options] <id>`](/docs/cli/reference/app#synq-app-install) | Create or update an app installation draft; deploy its returned project ID with synq deploy |
| [`custom`](/docs/cli/reference/app/custom#synq-app-custom) | Manage this organization's custom app definitions |
| [`settings`](/docs/cli/reference/app#synq-app-settings) | Read and update an installed app's curated settings |
| [`connection <project>`](/docs/cli/reference/app#synq-app-connection) | Show resolved app connection details, including credentials; requires project write access |

## synq app connection

Show resolved app connection details, including credentials; requires project write access

```text
synq app connection [options] <project>
```

| Argument | Meaning |
| --- | --- |
| `project` | Installed app project ID |

## synq app get

Show an app template and an accessible installation draft

```text
synq app get [options] <id>
```

| Argument | Meaning |
| --- | --- |
| `id` | Catalog app ID |

## synq app host-fit

Check an app's requirements against a deployment destination

```text
synq app host-fit [options] <id>
```

| Argument | Meaning |
| --- | --- |
| `id` | Catalog app ID |

| Option | Meaning |
| --- | --- |
| `--server <id>` | Registered server ID |
| `--target <target>` | Deployment target, such as cloud |

## synq app install

Create or update an app installation draft; deploy its returned project ID with synq deploy

```text
synq app install [options] <id>
```

| Argument | Meaning |
| --- | --- |
| `id` | Catalog app ID |

| Option | Meaning |
| --- | --- |
| `--name <name>` | Project name |
| `--config <file>` | JSON object of app configuration values |
| `--routes <file>` | JSON array of endpoint routing choices |

## synq app list

List available catalog apps

```text
synq app list|ls [options]
```

## synq app settings

Read and update an installed app's curated settings

```text
synq app settings [options] [command]
```

| Subcommand | Purpose |
| --- | --- |
| [`get <project>`](/docs/cli/reference/app#synq-app-settings-get) |  |
| [`update <project> <file>`](/docs/cli/reference/app#synq-app-settings-update) |  |

## synq app settings get

Use this command with the arguments below.

```text
synq app settings get [options] <project>
```

| Argument | Meaning |
| --- | --- |
| `project` | Installed app project ID |

## synq app settings update

Use this command with the arguments below.

```text
synq app settings update [options] <project> <file>
```

| Argument | Meaning |
| --- | --- |
| `project` | Installed app project ID |
| `file` | JSON object containing a changes array of &#123;service, key, value&#125; |