@adkit/cli 1.12.1

package/README.md

@@ -0,0 +1,184 @@
+# AdKit — the Ads CLI for AI agents
+
+The **Ads CLI** for AI agents and humans. Manage Meta & Google ad campaigns, browse the ad library, and generate creatives — all from your terminal. Part of [AdKit](https://adkit.so).
+
+## Installation
+
+```bash
+npm install -g @adkit/cli
+```
+
+The installed command is `adkit`.
+
+## Authentication
+
+```bash
+adkit setup
+```
+
+Opens a browser to connect your AdKit account. Your API key is stored locally.
+
+## Commands
+
+```
+adkit status                  Show current project and connected accounts
+adkit setup                   Authenticate (opens browser)
+adkit projects                Manage projects
+adkit library                 Browse the ad library
+adkit studio                  Create and manage Studio ads
+adkit manage                  Manage live campaigns on Meta and Google
+adkit logout                  Remove stored credentials
+```
+
+### Projects
+
+```bash
+adkit projects list
+adkit projects use <name>
+adkit projects current
+```
+
+### Ad Library
+
+Browse competitor ads and advertisers tracked by AdKit.
+
+```bash
+adkit library advertisers list --search "notion" --platform meta
+adkit library advertisers <id>
+adkit library advertisers similar --industry saas
+adkit library ads list --advertiser <id>
+adkit library ads <id>
+```
+
+### Studio
+
+Create and manage AI-generated ads.
+
+```bash
+adkit studio ads list
+adkit studio ads generate --ref media:<id> --mode clone
+adkit studio ads <id>
+adkit studio media upload ./banner.png
+adkit studio media list
+```
+
+### Meta (Facebook / Instagram)
+
+**Accounts**
+```bash
+adkit manage meta accounts list
+adkit manage meta accounts connect
+adkit manage meta accounts disconnect <id>
+```
+
+**Campaigns**
+```bash
+adkit manage meta campaigns list
+adkit manage meta campaigns create --name "Spring Sale" --objective sales --budget-daily 50 --publish
+adkit manage meta campaigns update <id> --status paused
+adkit manage meta campaigns delete <id>
+adkit manage meta campaigns <id>
+```
+
+**Ad Sets**
+```bash
+adkit manage meta adsets list
+adkit manage meta adsets create --campaign <id> --name "US Broad" \
+  --optimization conversions --event-type purchase --countries US --budget-daily 20 --publish
+adkit manage meta adsets update <id> --budget-daily 50
+adkit manage meta adsets delete <id>
+```
+
+**Ads**
+```bash
+adkit manage meta ads list
+adkit manage meta ads create --adset <id> --media ./image.jpg \
+  --primary-text "Try it free" --headline "AdKit" --cta sign_up --url https://example.com --publish
+adkit manage meta ads create --adset <id> \
+  --media ./feed.jpg --media ./story.mp4 --media-format default --media-format vertical \
+  --primary-text "Try it free" --headline "AdKit" --url https://example.com --publish
+adkit manage meta ads update <id> --status paused
+adkit manage meta ads delete <id>
+adkit manage meta ads <id>
+```
+
+**Results & Research**
+```bash
+adkit manage meta results                        # Spend, clicks, conversions
+adkit manage meta research interests "saas tools"
+adkit manage meta pages list
+adkit manage meta pixels list
+```
+
+**Drafts**
+```bash
+adkit manage drafts list
+adkit manage drafts <id>
+adkit manage drafts publish <id>
+adkit manage drafts delete <id>
+```
+
+### Google Ads
+
+**Accounts**
+```bash
+adkit manage google accounts list
+adkit manage google accounts connect
+adkit manage google accounts disconnect <id>
+```
+
+**Campaigns**
+```bash
+adkit manage google campaigns list --account <id>
+adkit manage google campaigns create --name "Search Test" --campaign-type search --budget-daily 5 --account <id> --publish
+adkit manage google campaigns update <id> --status paused --account <id>
+adkit manage google campaigns delete <id> --account <id>
+```
+
+**Ad Groups, Ads, Keywords**
+```bash
+adkit manage google ad-groups list --campaign <id> --account <id>
+adkit manage google ads list --ad-group <id> --account <id>
+adkit manage google keywords list --ad-group <id> --account <id>
+adkit manage google keywords add --ad-group <id> --text "project management software" --match-type broad --account <id>
+adkit manage google negative-keywords add --campaign <id> --text "free" --account <id>
+```
+
+**Assets (callouts, sitelinks, snippets, call extensions)**
+```bash
+adkit manage google assets list --type callout --account <id>
+adkit manage google assets create --type callout --text "Free 14-day trial" --account <id>
+adkit manage google assets create --type sitelink --sitelink "Pricing|https://example.com/pricing" \
+  --description-1 "See all plans" --description-2 "Starts free" --account <id>
+adkit manage google assets create --type call --country-code US --phone-number "+14155551234" --account <id>
+adkit manage google assets attach asset:<id> --type callout --scope campaign --scope-id <id> --account <id>
+```
+
+**Results & Research**
+```bash
+adkit manage google results --account <id>
+adkit manage google search-terms --account <id>
+adkit manage google research keywords "project management" --account <id>
+```
+
+## Global Flags
+
+```
+--json        Force JSON output (default when stdout is not a TTY)
+--project     Override the active project for this command
+--help        Show help  (--help full for complete field reference)
+```
+
+## Agent / Programmatic Use
+
+All commands output JSON automatically when stdout is not a TTY, making `adkit` easy to use from AI agents or scripts:
+
+```bash
+adkit manage meta campaigns list --json | jq '.[].name'
+```
+
+Create items as drafts (default) and publish in a separate step, or pass `--publish` to go live immediately.
+
+## More
+
+- Docs: [adkit.so/docs](https://adkit.so/docs)