wehub-resource-sync
41 lines
1.1 KiB
Markdown
41 lines
1.1 KiB
Markdown
# DBX Examples
|
|
|
|
Runnable samples for common DBX workflows.
|
|
|
|
| Directory | What it shows |
|
|
| --- | --- |
|
|
| [cli/](cli/) | Terminal queries with `@dbx-app/cli` |
|
|
| [mcp/](mcp/) | MCP configs for Cursor and Claude Code |
|
|
| [docker/](docker/) | Self-hosted Docker deployment |
|
|
| [web-api/](web-api/) | Minimal HTTP API automation against DBX Web |
|
|
|
|
## Before You Run
|
|
|
|
1. Install DBX Desktop, or start the Docker/Web version.
|
|
2. Create at least one connection in DBX.
|
|
3. For CLI examples, install the CLI:
|
|
|
|
```bash
|
|
npm install -g @dbx-app/cli
|
|
```
|
|
|
|
4. For MCP examples, install the MCP server:
|
|
|
|
```bash
|
|
npm install -g @dbx-app/mcp-server
|
|
```
|
|
|
|
## Suggested Learning Path
|
|
|
|
1. Read [Getting Started](https://dbxio.com/en/docs/getting-started)
|
|
2. Try the CLI workflow in `cli/basic-workflow.sh`
|
|
3. Copy an MCP config from `mcp/` into your project
|
|
4. If you self-host DBX, use `docker/docker-compose.yml`
|
|
5. For custom integrations, inspect `web-api/automation.sh`
|
|
|
|
More docs:
|
|
|
|
- [CLI reference](https://dbxio.com/en/docs/cli)
|
|
- [MCP integration](https://dbxio.com/en/docs/mcp)
|
|
- [Web API reference](https://dbxio.com/en/docs/web-api)
|