You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit 6f634c6
Browse filesBrowse the repository at this point in the historyBrowse files
docs: rewrite README with complete command reference (#13)
* docs: rewrite README with complete command reference
Replace the old README with a comprehensive reference covering all 117
commands (50 Google Ads, 67 Meta Ads) organized by theme. Remove the
manual refresh step, add "Why use the CLI" section, architecture
diagram, MCP cross-links, and community section.
* docs: focus intro on convenience over internals
Command-line tool for managing Meta Ads, Google Ads, and TikTok Ads from your terminal. Built for AI agents and automation — authenticate once, connect your ad platforms via OAuth, and let your agents manage campaigns, pull reports, and optimize ads across platforms.
3
+
Manage Meta Adsand Google Ads from your terminal. Single binary, zero dependencies, 50ms startup.
4
4
5
-
Works as an alternative to [Pipeboard](https://pipeboard.co)'s MCP servers for agents that prefer CLI tools. Pipeboard gives you control over which ad accounts the CLI can access, and you can create API tokens scoped to specific accounts and commands.
5
+
Built for AI coding agents (Claude Code, Cline, OpenClaw) and automation scripts. No need to register apps with each ad platform, run your own MCP servers, or maintain brittle API scripts — authenticate once with [Pipeboard](https://pipeboard.co) and go.
6
+
7
+
## Why use the CLI
8
+
9
+
-**All platforms, one binary** — Meta Ads and Google Ads without configuring separate MCP servers
10
+
-**More tools than local MCP** — 117 commands covering campaigns, creatives, audiences, reporting, and more
11
+
-**Fast for agents** — sub-50ms cold start. Agents shell out to `pipeboard` instead of implementing MCP JSON-RPC
12
+
-**Scriptable** — pipe JSON output into `jq`, chain commands in bash, run from CI
6
13
7
14
## Installation
8
15
@@ -20,7 +27,7 @@ go install github.com/pipeboard-co/pipeboard-cli@latest
20
27
21
28
### Binary download
22
29
23
-
Download the latest release from [GitHub Releases](https://github.com/pipeboard-co/pipeboard-cli/releases).
30
+
Download from [GitHub Releases](https://github.com/pipeboard-co/pipeboard-cli/releases). Builds for macOS (arm64/amd64), Linux (arm64/amd64), and Windows (amd64).
24
31
25
32
## Authentication
26
33
@@ -36,7 +43,7 @@ Or store it in the config file:
36
43
pipeboard config set token <your-token>
37
44
```
38
45
39
-
Get your API token at [pipeboard.co/settings](https://pipeboard.co/settings).
46
+
Get your API token at [pipeboard.co/api-tokens](https://pipeboard.co/api-tokens).
40
47
41
48
### Browser OAuth (interactive)
42
49
@@ -46,52 +53,286 @@ pipeboard login
46
53
47
54
## Quick Start
48
55
49
-
After authenticating, fetch the available tools:
50
-
51
-
```bash
52
-
pipeboard refresh
53
-
```
54
-
55
-
This downloads tool definitions from Pipeboard's MCP servers and caches them locally at `~/.pipeboard/tools-cache.json`. Run this once after install, or again when new tools are available.
56
-
57
-
## Usage
58
-
59
-
Commands are auto-generated from Pipeboard's MCP tool definitions. Each ad platform is a top-level command with subcommands for every available operation.
|`get-insights`| Get performance insights for any object |
256
+
|`bulk-get-insights`| Get insights for multiple objects at once |
257
+
|`create-email-report`| Send an AI-powered email performance report |
258
+
|`list-email-reports`| List email report schedules |
259
+
|`update-email-report`| Update an email report schedule |
260
+
|`delete-email-report`| Delete an email report schedule |
261
+
262
+
#### Account & Pages
263
+
264
+
| Command | Description |
265
+
|---------|-------------|
266
+
|`get-ad-accounts`| List accessible ad accounts |
267
+
|`get-account-info`| Get account details |
268
+
|`get-account-pages`| Get pages associated with an account |
269
+
|`get-instagram-accounts`| Get Instagram accounts for an ad account |
270
+
|`get-pixels`| List Meta pixels for an account |
271
+
|`search-pages-by-name`| Search for pages by name |
272
+
273
+
#### Lead Generation
274
+
275
+
| Command | Description |
276
+
|---------|-------------|
277
+
|`create-lead-gen-form`| Create a lead gen form on a Page |
278
+
|`get-lead-gen-forms`| List lead gen forms for a Page |
279
+
|`publish-lead-gen-draft-form`| Publish a draft lead gen form |
280
+
|`update-lead-gen-form-status`| Archive or reactivate a form |
281
+
282
+
#### Product Catalogs
283
+
284
+
| Command | Description |
285
+
|---------|-------------|
286
+
|`list-catalogs`| List product catalogs for an account |
287
+
|`list-product-sets`| List product sets in a catalog |
288
+
289
+
#### Other
290
+
291
+
| Command | Description |
292
+
|---------|-------------|
293
+
|`submit-feedback`| Report a bug or request a feature |
294
+
295
+
## How It Works
85
296
86
-
```bash
87
-
# Build
88
-
make build
297
+
```
298
+
pipeboard <platform> <command> [flags]
299
+
│
300
+
▼
301
+
MCP JSON-RPC client (HTTP POST)
302
+
│
303
+
▼
304
+
https://mcp.pipeboard.co/<server>
305
+
│
306
+
▼
307
+
Meta / Google APIs
308
+
```
309
+
310
+
The CLI is a thin client. All API calls go through Pipeboard's cloud — auth tokens, rate limiting, and logging are handled server-side. This is why the CLI repo contains no secrets and can be fully open-source.
311
+
312
+
## Also Available: MCP Servers
313
+
314
+
If you prefer MCP over CLI, Pipeboard offers remote MCP servers for the same platforms:
89
315
90
-
# Run tests
91
-
make test
316
+
| Platform | Remote MCP URL |
317
+
|---|---|
318
+
| Meta Ads |`https://mcp.pipeboard.co/meta-ads-mcp`|
319
+
| Google Ads |`https://mcp.pipeboard.co/google-ads-mcp`|
92
320
93
-
# Install locally
94
-
make install
321
+
Works with Claude Pro/Max, Cursor, and any MCP client. Set up at [pipeboard.co](https://pipeboard.co).
322
+
323
+
## Community
324
+
325
+
-[Discord](https://discord.gg/YzMwQ8zrjr) — join the community
326
+
-[Email](mailto:info@pipeboard.co) — support and questions
327
+
-[Issues](https://github.com/pipeboard-co/pipeboard-cli/issues) — bug reports and feature requests
0 commit comments