# SmallForce complete documentation

<!-- source: home -->

# SmallForce documentation

SmallForce is an AI operations platform for agencies and small businesses. Your AI employees can work with your business knowledge, use connected services, communicate through the channels you already use, and complete work across websites, marketing, advertising, calls, meetings, media, and research.

## Start with the platform

- [What is SmallForce?](/docs/start/what-is-smallforce) explains the product and its main capabilities.
- [Set up SmallForce](/docs/start/set-up-smallforce) walks through your organization, employees, workspace, and first connection.
- [AI employees](/docs/employees/overview) explains instructions, conversations, tools, and business context.
- [The searchable workspace](/docs/workspace/overview) explains how files become useful business knowledge.

## Work from anywhere

Use SmallForce from the [web, desktop, and mobile apps](/docs/apps/overview), from [Apple Watch](/docs/apps/apple-watch), or through [Slack and Telegram](/docs/channels/overview). The surface can change without changing the employee or the business context available to it.

## Run client and business operations

- [Websites and applications](/docs/websites/overview)
- [AI media and assets](/docs/media/overview)
- [Social media management](/docs/social-media/overview)
- [Meta advertising](/docs/advertising/overview)
- [Calls and AI receptionists](/docs/calls/overview)
- [Meeting recording and transcription](/docs/meetings/overview)
- [Web and social scrapers](/docs/scrapers/overview)
- [Google Business Profile](/docs/google-business/overview)
- [Connected apps and automations](/docs/integrations/overview)

## Automate with the CLI

The public [SmallForce CLI](/docs/cli/overview) is designed for both people and agents. Its generated [command reference](/docs/cli/commands) documents the exact syntax, flags, defaults, examples, and subcommands shipped in the current CLI.

SmallForce documentation describes public product behavior and supported interfaces. It does not expose private infrastructure, storage, runtime, or deployment implementation details.

---

<!-- source: employees/overview -->

# AI employees in SmallForce

An [AI employee](/ai-agents-for-business) is a continuing worker inside your organization, not a disposable chat prompt. You can give an employee a role, operating instructions, business context, and access to the tools required for its work.

## What an employee can use

Depending on what your organization has enabled, an employee can:

- Search and read files in the organization workspace.
- Work on websites and generated applications.
- Use connected external applications.
- Generate and manage media assets.
- Operate social publishing, inbox, reviews, and analytics.
- Work with advertising campaigns and leads.
- Run approved web and social scrapers.
- Continue work from supported apps and communication channels.

## Give durable instructions

Describe responsibility and decision boundaries, not only personality. A useful instruction answers:

- What outcomes does this employee own?
- Which organization or client does it represent?
- Which source material should it trust?
- What requires confirmation before execution?
- How should it communicate progress and final results?

Keep changing campaign details, temporary deadlines, and one-off requests in the conversation or project files. Keep durable operating rules in the employee’s instructions.

## Conversations and context

Start a new conversation when beginning unrelated work. Continue an existing conversation when the employee needs the decisions and progress from that thread. Slack threads and Telegram topics provide channel-specific ways to keep work organized without exposing technical session details.

For business facts, add the relevant source files to the [workspace](/docs/workspace/overview) so the employee can search the source instead of relying on a remembered paraphrase.

---

<!-- source: meetings/overview -->

# AI meeting recording and transcription with SmallForce

SmallForce Meetings turns recorded conversations into reusable business knowledge. Record a meeting from a supported app, upload the audio to the selected organization, create a transcript, and use the result in later employee work.

## Meeting workflow

1. Start a recording and confirm the microphone or system-audio permissions required by the device.
2. Pause, resume, or stop the recording from the active recording controls.
3. Keep the saved recording locally until upload succeeds.
4. Upload it to the intended SmallForce organization.
5. Request transcription and review the completed transcript.
6. Ask an employee to summarize decisions, extract action items, or locate a specific discussion.

Meetings receive a default date-based title that can be distinguished from other recordings. The meeting view shows recording time, duration, upload state, and transcript availability.

## Search and reuse

Meeting transcripts are stored as organization knowledge and can be searched like other readable workspace documents. This makes it possible to find a decision without remembering the meeting title or exact phrasing.

Always follow applicable recording-consent and privacy requirements. SmallForce provides recording controls; the organization using them is responsible for obtaining required consent.

---

<!-- source: calls/overview -->

# AI phone calls and receptionists with SmallForce

SmallForce [phone employees](/ai-receptionist) can help a business answer calls, gather information, follow approved instructions, and route the result into later work. Calls are managed as an organization capability rather than as commands in the public SmallForce CLI.

## Set up a phone employee

Define the employee’s purpose, greeting, business knowledge, escalation rules, and the actions it may take. Provide accurate hours, locations, services, scheduling rules, and other frequently requested information through approved instructions and workspace files.

Connect or assign the intended phone number, then test common and difficult scenarios before directing real customer traffic to it. Tests should include unclear audio, unsupported requests, urgent situations, requests for a person, and questions whose answer is not in the approved knowledge.

## Review calls

The Calls experience can show call status, participant information, duration, and available recording or transcript data. When recording and transcription are enabled, authorized users can review the source conversation, search relevant text, and ask an employee to prepare follow-up work.

Do not instruct a phone employee to invent policies or make commitments it cannot fulfill. Always follow applicable call-recording, consent, telemarketing, and industry rules.

---

<!-- source: integrations/overview -->

# Connect business apps and automate work with SmallForce

Integrations let SmallForce employees work with external applications. A connection represents one authorized account. Events can notify an employee when something happens, while tools perform an explicit provider action.

## Three-step model

1. **Connections:** Authorize the exact external account the organization should use.
2. **Events:** Discover incoming events and configure which employee receives them, with instructions for handling the payload.
3. **Tools:** Search for an action by intent, inspect its input schema, and execute it against an explicit connection.

```bash
smallforce integrations connections connect gmail
smallforce integrations events list --connection <connectionId>
smallforce integrations tools search "send an email"
```

Always resolve connection IDs, event slugs, tool slugs, and input schemas from the current organization. Do not guess provider contracts. Keep event instructions focused on the decision or work the employee should perform.

Slack as an executable external integration is different from the [Slack employee channel](/docs/channels/slack), which is where a team chats with SmallForce inside Slack.

---

<!-- source: websites/overview -->

# Create and operate websites with SmallForce

SmallForce employees can [create a website](/ai-website-builder) project, work on its files, deploy releases, and continue making changes from the website workspace. Agencies can keep each client website organized as its own project while using the same operational workflow.

## Typical workflow

1. Ask an employee to create a website and describe the business, audience, pages, and required outcome.
2. The employee initializes a SmallForce application inside the organization workspace.
3. Review the generated site and provide feedback in the project conversation.
4. The employee edits the project files and verifies the build.
5. Deploy an immutable release and review it on the organization-gated Preview environment.
6. Promote that ready release to Production without rebuilding it.
7. Continue with access control, environment-specific configuration, logs, analytics, or diagnostics as needed.

SmallForce’s built-in application templates include a website, a presentation, and an API-oriented worker. A project can also start from another supported template source.

## Website projects and releases

The local project manifest identifies the stable SmallForce application and its build configuration; it does not cache live URLs or release state. Deployment builds the project, packages its server entrypoint and assets, uploads an immutable release, and waits until Preview serves it. Production, Preview, and custom environments are stable URLs with independent configuration, SQLite data, files, and observability. Promotion changes which ready release an environment serves without copying that data.

Technical users can operate the same workflow through the [SmallForce CLI app commands](/docs/cli/commands/app). Start with [creating a website](/docs/websites/create) or [deploying and operating releases](/docs/websites/deploy-and-operate).

---

<!-- source: media/overview -->

# Generate AI images, video, and audio with SmallForce

SmallForce Media provides model discovery, schema-guided generation, asynchronous jobs, and reusable organization assets. An employee can choose a model for the creative goal instead of assuming every model accepts the same inputs.

## Model-first workflow

1. Search the enabled model catalog by intent and output type.
2. Inspect the selected model’s current input schema and required fields.
3. Upload source images or other required files as SmallForce assets.
4. Submit the generation job with inputs that match the schema.
5. Wait for completion or continue other work while it runs.
6. Reuse or download the resulting organization-owned assets.

This supports text-to-image, image editing, image-to-video, and other workflows exposed by the enabled catalog. Available models and input shapes can change, so discovery results are the source of truth.

Use generated media in websites, social posts, advertising creative, Google Business photos, and other client work. Keep the original brief and approval status with the project so employees do not treat an unapproved draft as final creative.

See [generate media with the CLI](/docs/media/cli-workflow) or the exact [`smallforce media` command reference](/docs/cli/commands/media).

---

<!-- source: advertising/overview -->

# Manage Meta Ads with SmallForce AI employees

SmallForce provides a structured [Meta Ads workflow](/ads-autopilot) for connections, ad accounts, campaigns, targeting, reach, lead forms, leads, and analytics.

## Recommended campaign workflow

1. Connect Meta through the social profile that owns the Facebook or Instagram account.
2. Activate the connection and synchronize available ad accounts.
3. Resolve the SmallForce ad-account ID.
4. Search valid targeting dimensions and estimate reach.
5. Validate the complete campaign draft.
6. Preview and create the campaign in a paused state.
7. Run preflight checks.
8. Review budget, creative, destination, and tracking before activation.
9. Monitor performance and captured leads.

SmallForce creates campaigns paused so an employee or operator can review the result before spending begins. Require explicit approval for budget increases, activation, destructive changes, and other actions defined by your organization’s advertising policy.

See [create and activate a campaign](/docs/advertising/campaign-workflow) or the complete [`smallforce ads` reference](/docs/cli/commands/ads).

---

<!-- source: google-business/overview -->

# Manage Google Business Profile with SmallForce

SmallForce can manage accessible [Google Business Profile](/google-my-business-management) accounts and locations, selected location fields, photos, place-action links, performance metrics, and search-keyword data.

Start by listing the account and location pairs available to the organization:

```bash
smallforce gmb accounts list --json
smallforce gmb locations get <accountId> <destinationId>
```

## Location operations

- Read and update supported location fields.
- Add organization-owned assets as location photos.
- List and delete supported photos.
- Create, update, and remove appointment or other place-action links.
- Review daily performance metrics.
- Inspect search terms that surfaced a location.

[Google Business reviews](/google-reviews) are managed through [SmallForce social reviews](/docs/social-media/engagement-and-analytics), keeping review handling with the broader engagement workflow.

Resolve account and destination IDs from SmallForce rather than copying provider identifiers from another client. See the complete [`smallforce gmb` reference](/docs/cli/commands/gmb).

---

<!-- source: agency-guides/overview -->

# Run an agency with SmallForce AI employees

SmallForce can organize repeatable agency work without forcing every client into one undifferentiated chat. Start with clear organization ownership, client folders, responsible employees, connected accounts, and approval boundaries.

## Example operating cycle

1. Add the client brief, brand guidance, approved offers, and existing work to the searchable workspace.
2. Assign employees for client operations, content, websites, media, advertising, or reporting.
3. Connect only the client accounts required for the approved scope.
4. Create the website, campaign, social calendar, or research deliverable.
5. Validate and present work before publishing, activation, spending, or customer contact.
6. Monitor results and save approved knowledge back into the client workspace.

## Keep client work clear

- Use descriptive client and project folders.
- Start new conversations for unrelated workstreams.
- Keep durable client rules in employee instructions or approved workspace documents.
- Use explicit IDs and account names before any provider mutation.
- Record who approved publishing, activation, spend, or access changes.
- Treat meeting and call transcripts as source material, not automatic approval.

SmallForce capabilities can be combined, but each public interface remains independently documented so employees and operators can verify the exact contract before acting.

---

<!-- source: apps/overview -->

# SmallForce apps and devices

SmallForce is available across first-party apps and devices. These are different from Slack and Telegram channels: they provide the complete SmallForce product experience rather than embedding an employee in another communication service.

- The **web app** provides organization management, employees, workspaces, channels, calls, social, advertising, integrations, and other administrative surfaces.
- The **desktop app** provides a desktop-first workspace, conversations, project work, and supported meeting recording.
- The **mobile app** provides employee chat, business access on the move, meeting recording, notifications, and mobile task progress.
- The **Apple Watch app** provides quick employee access and voice-first requests through a paired iPhone.

Select the correct organization before starting work or uploading files. Continue an existing conversation when the prior context matters, or create a new conversation for unrelated work.

See [communication channels](/docs/channels/overview) when you want to use SmallForce from Slack or Telegram instead.

---

<!-- source: cli/overview -->

# SmallForce CLI documentation

The `smallforce` CLI is the public command interface for agents, scripts, and technical users. It manages organization-owned SmallForce resources through stable commands and optional machine-readable output.

## Public command groups

| Command | Purpose |
| --- | --- |
| `smallforce org` | Inspect the organization authenticated by the API key |
| `smallforce app` | Create, deploy, inspect, configure, and protect generated applications |
| `smallforce integrations` | Manage connections, incoming events, and executable tools |
| `smallforce media` | Discover models and generate images, video, and audio |
| `smallforce assets` | Upload, retrieve, download, and delete organization files |
| `smallforce social` | Manage social accounts, posts, inbox, reviews, synchronization, and analytics |
| `smallforce ads` | Manage Meta Ads connections, campaigns, targeting, leads, and analytics |
| `smallforce seo` | Discover and run SEO, local-search, competitor, and AI-search research capabilities |
| `smallforce scrapers` | Discover scrapers and operate asynchronous runs |
| `smallforce gmb` | Manage Google Business locations, photos, actions, and analytics |

Start with [installation and authentication](/docs/cli/getting-started), then use the generated [complete command reference](/docs/cli/commands). Every reference page is built directly from the Commander definition shipped by the CLI.

Only `smallforce` is a public CLI. Internal operating-system utilities are intentionally not part of this documentation.

---

<!-- source: channels/overview -->

# SmallForce communication channels

Channels bring SmallForce employees into [communication tools your team already uses](/multiplayer-ai). Slack and Telegram are separate from social-media inboxes: they are places where your own team gives employees work and receives results.

## Supported channels

- [Slack](/docs/channels/slack) supports connected workspaces, channel-specific employee selection, thread-based conversations, files, and configurable progress visibility.
- [Telegram](/docs/channels/telegram) supports connected groups, employee-specific topics, files, and configurable progress visibility.

## Choose the right employee

Assign the employee responsible for the work performed in a channel or topic. This avoids repeatedly explaining which role should respond. Begin unrelated work in a new Slack thread or Telegram topic; continue the existing thread when prior decisions are still relevant.

## Control progress visibility

Channel connections can present only the final answer, a compact set of useful status updates, or more detailed intermediate activity. Use final-only for busy shared channels and detailed progress when the team needs to follow longer work.

Channel documentation covers connection and visible conversation behavior. It does not expose internal routing, credentials, queues, or session identifiers.

---

<!-- source: cli/commands/org -->

# `smallforce org`

Inspect the SmallForce organization for this API key

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce org --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce org get`](/docs/cli/commands/org/get): Get organization details

## Complete command help

```text
Usage: smallforce org [options] [command]

Inspect the SmallForce organization for this API key

Options:
  -h, --help      display help for command

Commands:
  get [options]   Get organization details
  help [command]  display help for command
```

## Related reference

- [`smallforce`](/docs/cli/commands): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: workspace/overview -->

# SmallForce searchable workspace

The workspace is the organization’s working area for files and business knowledge. Files placed there can be browsed by people and used by AI employees with access to that organization.

Supported files are indexed so a search can find exact phrases and conceptually related passages. This lets an employee locate the relevant source before answering questions or creating new work.

## What belongs in a workspace

- Brand guidelines and approved creative.
- Product, service, and pricing information.
- Client briefs and campaign plans.
- Policies, procedures, and reference documents.
- Spreadsheets and reports.
- Meeting recordings and transcripts.
- Website and application projects.
- Research and employee-created deliverables.

Organize files around durable business concepts: clients, departments, campaigns, or projects. Descriptive names improve browsing and make search results easier to recognize.

## Searchable does not mean public

Workspace search is for the organization’s own files and knowledge. Public web research is a different capability. An employee should use workspace sources for customer-specific facts and live web research for current public information.

The public product contract is simple: add supported files, allow indexing to complete, then search or ask an employee to locate the relevant information. Internal storage locations and indexing implementation are not part of the public interface.

Continue with [searching the workspace](/docs/workspace/search) or [supported file types](/docs/workspace/supported-files).

---

<!-- source: social-media/overview -->

# Social media management with SmallForce AI employees

SmallForce brings publishing, inbox conversations, reviews, synchronization, and analytics into one organization-owned [social workflow](/social-media).

## Core concepts

**Platforms** describe supported networks and their current publishing capabilities. **Profiles** group connected accounts that belong to the same brand or client. **Accounts** are the actual provider destinations used for publishing and data access.

## What you can do

- Discover supported platforms and platform-specific options.
- Create brand profiles and connect social accounts.
- Draft, validate, publish immediately, or schedule posts.
- Customize text and media for each target account.
- Upload and reuse SmallForce assets.
- Inspect publication results and retry failed destinations.
- Read and reply to supported inbox conversations.
- Read and respond to Facebook and Google Business reviews.
- Synchronize provider-created posts and account state.
- Analyze posting, followers, content performance, and provider-specific metrics.

Validate a post before publishing whenever possible. Do not invent account IDs or platform options; discover them from the organization and the current platform schema.

Continue with [publishing posts](/docs/social-media/publishing) or [inbox, reviews, and analytics](/docs/social-media/engagement-and-analytics).

---

<!-- source: scrapers/overview -->

# Web and social media scrapers in SmallForce

SmallForce Scrapers provides a curated catalog for web and social research. Search the catalog by intent, inspect the scraper’s current input schema, submit a run, and retrieve its structured result items after completion.

```bash
smallforce scrapers search "Instagram reels" --json
smallforce scrapers run <scraperId> \
  --input '<json-built-from-the-scraper-schema>' \
  --max-credits 20 \
  --json
```

Runs are asynchronous. Use the returned SmallForce run ID to check status and retrieve items:

```bash
smallforce scrapers runs get <runId> --json
smallforce scrapers runs items <runId> --json
```

`--max-credits` creates a hard ceiling for the run. SmallForce reserves that amount before submission and settles it against the actual cost.

Use scrapers only for authorized purposes and handle personal or platform data according to applicable terms and law. Source media URLs may be temporary, so process required files promptly instead of treating external URLs as permanent storage.

See the complete [`smallforce scrapers` reference](/docs/cli/commands/scrapers).

---

<!-- source: start/what-is-smallforce -->

# What is SmallForce?

SmallForce gives an organization AI employees that can understand instructions, work with business files, use connected applications, and complete multi-step work. It is built for ongoing operations rather than isolated prompts.

An agency can use SmallForce to launch a client website, prepare campaign creative, manage social publishing, operate Meta Ads, research a market, handle calls, and follow up with leads. A small business can use the same platform without managing a collection of disconnected AI tools.

## The main parts

**AI employees** receive tasks through chat and connected channels. Each employee can have a role, instructions, and access to the tools needed for that role.

**The workspace** holds business files and generated knowledge. Supported documents are indexed so employees can find relevant information by exact wording or meaning before answering.

**Channels and apps** let you work from the web, desktop, mobile, Apple Watch, Slack, or Telegram. Conversations remain attached to the employee and the work instead of being limited to one device.

**Capabilities** are the operational areas employees can work in: websites, media, social, advertising, calls, meetings, scrapers, Google Business Profile, and connected external applications.

**The SmallForce CLI** provides a stable command interface for agents, scripts, and technical users. It covers generated apps, integrations, media, assets, social, ads, scrapers, and Google Business Profile.

## SmallForce for agencies

SmallForce can support repeatable client workflows while keeping each task grounded in the relevant organization and workspace. Start with [agency workflows](/docs/agency-guides/overview) or continue to [set up SmallForce](/docs/start/set-up-smallforce).

---

<!-- source: channels/slack -->

# Connect SmallForce AI employees to Slack

Connect Slack when a team wants to assign work and receive results without leaving its workspace.

## Connect a workspace

1. Open **Channels → Slack** in SmallForce.
2. Choose **Add to Slack** and authorize the SmallForce Slack app for the intended workspace.
3. In Slack, open a channel and enter `/invite @SmallForce`. Public and private channels are supported when SmallForce has been invited.
4. Mention `@SmallForce` in a new message to start work.

SmallForce replies inside the Slack thread so normal channel conversation stays tidy. Continue in that thread for follow-up work that depends on the same context.

## Assign an employee

In the Slack channel settings shown by SmallForce, select the employee that should handle new threads in that channel. Different channels can route work to different employees—for example, a content employee in `#marketing` and a client-operations employee in `#delivery`.

## Select progress visibility

- **Final answer only** sends the completed response.
- **Compact progress** updates one concise status message and then sends the final response.
- **Detailed progress** shows available intermediate activity before the final response.

An organization owner or admin manages Slack workspace connections. If a channel does not appear, confirm SmallForce was invited and refresh the channel list.

---

<!-- source: websites/create -->

# Create a website with a SmallForce AI employee

Start from the SmallForce chat interface and ask the employee to use the website creation workflow. Include the business name, goal, audience, required pages, available brand material, and any deadline or approval constraint.

A useful first message is:

> Use the website creation skill to help me create and deploy a new website.

The employee can gather missing requirements, initialize the project inside the organization’s websites workspace, and use the template’s design guidance. If you explicitly request another folder, the employee can follow that location when it is valid for the workspace.

## Give the employee useful source material

- Brand guidelines, logo, fonts, and colors.
- Approved service and product descriptions.
- Contact information and calls to action.
- Reference websites and explicit likes or dislikes.
- Required analytics, forms, integrations, or access restrictions.

Review the first preview as a working draft. Keep feedback concrete: identify the page, section, intended change, and desired customer response. Continue in the same project conversation so the employee has the project context.

Technical users can initialize directly with [`smallforce app init`](/docs/cli/commands/app/init), but chat remains the primary editing experience for users who do not need command-level control.

---

<!-- source: advertising/campaign-workflow -->

# Create and activate a Meta Ads campaign safely

Resolve a connected local ad account before building the draft:

```bash
smallforce ads accounts list --json
smallforce ads targeting search "coffee" \
  --account <adAccountId> \
  --dimension interest \
  --json
```

Complex mutations accept inline JSON, `--input-file <path>`, or stdin with `--input-file -`. Validate before creation:

```bash
smallforce ads campaigns validate --input-file campaign.json
smallforce ads campaigns preview --input-file campaign.json
smallforce ads campaigns create --input-file campaign.json --json
```

The created campaign remains paused. Run preflight against the resulting campaign and ad account:

```bash
smallforce ads campaigns preflight <campaignId> \
  --account <adAccountId> \
  --json
```

Review every preflight issue, budget, schedule, audience, placement, destination, tracking choice, and creative. Activate only after the authorized person approves the campaign:

```bash
smallforce ads campaigns status <campaignId> active \
  --account <adAccountId>
```

Use stable idempotency inputs where available and inspect leaf help before mutations. Provider effects and accepted contracts can differ across campaign operations.

---

<!-- source: social-media/publishing -->

# Create, schedule, and publish social media posts

Begin with a connected account and the platform’s current publishing schema. A post can share common content while each publication targets one account and can override text, media, schedule, or platform options.

## Safe publishing workflow

1. List platforms, profiles, and accounts.
2. Upload any local media through SmallForce Assets.
3. Prepare one publication object per target account.
4. Validate the complete post.
5. Create it as a draft, publish now, or schedule it.
6. Inspect each account’s publication result and retry only failures that are safe to repeat.

```bash
smallforce social posts validate \
  --content "Hello from SmallForce" \
  --publish now \
  --publication '{"accountId":"<accountId>"}'

smallforce social posts create \
  --content "Hello from SmallForce" \
  --publish schedule \
  --scheduled-for 2030-07-15T14:00:00Z \
  --publication '{"accountId":"<accountId>"}'
```

Use an idempotency key when an agent or automation may retry the same creation request. See [`social posts create`](/docs/cli/commands/social/posts/create) for the exact publication structure.

---

<!-- source: media/cli-workflow -->

# Generate media and manage assets with the SmallForce CLI

Search before generating so the request matches an enabled model:

```bash
smallforce media models search "animate a product photo" --modality video --json
smallforce media models get <endpointId> --json
```

Build the generation input from the returned schema. For a model with a normal prompt field:

```bash
smallforce media generate <endpointId> \
  --prompt "A ceramic mug on a clean studio table" \
  --wait \
  --out ./mug.png
```

For an image input, upload the local file and use the returned asset ID:

```bash
smallforce assets upload ./product.png --json
smallforce media generate <endpointId> \
  --image <assetId> \
  --input '<json-built-from-inputSchema>' \
  --wait \
  --out ./product-video.mp4
```

Generation is asynchronous. Without `--wait`, the command returns a job. Use `media jobs list` and `media jobs get` to inspect it later. An output path implies waiting and downloads completed output assets.

Do not place local file paths or guessed asset URLs inside model JSON. Use `--image` or repeatable `--asset <field>=<assetId>` mappings. See the complete [media reference](/docs/cli/commands/media) and [assets reference](/docs/cli/commands/assets).

---

<!-- source: cli/getting-started -->

# Install and authenticate the SmallForce CLI

Install the npm package globally:

```bash
npm install --global smallforce
smallforce --help
```

Or run the latest published package without a global installation:

```bash
npx smallforce --help
```

Set the organization API key in the environment and verify which organization it authenticates:

```bash
export SMALLFORCE_API_KEY="sf_..."
smallforce org get
```

The production backend defaults to `https://backend.smallforcehq.com`. Local or staging environments can override it with `SMALLFORCE_BACKEND_URL` or `--backend-url`.

## Global options

| Option | Purpose |
| --- | --- |
| `--api-key <key>` | Override `SMALLFORCE_API_KEY` for one command |
| `--backend-url <url>` | Override `SMALLFORCE_BACKEND_URL` |
| `--json` | Print stable machine-readable output |
| `--text` | Force human-readable output |
| `--format text\|json` | Select an output format explicitly |
| `--help` | Show the current command contract |
| `--version` | Print the installed CLI version |

Do not place API keys directly in scripts, documentation, chat messages, or version-controlled files. Prefer environment or secret-management facilities.

---

<!-- source: integrations/events-and-tools -->

# Route integration events and execute provider tools

List events from the intended connection, inspect the payload and current rule, then configure the employee and instructions:

```bash
smallforce integrations events list --connection <connectionId>
smallforce integrations events get <eventSlug> --connection <connectionId>
smallforce integrations events configure <eventSlug> \
  --connection <connectionId> \
  --profile operator \
  --instructions "Summarize the event and identify the required next action." \
  --session event
```

Choose the conversation strategy based on the workflow. Independent events should not accidentally inherit unrelated context; related events may benefit from a stable workflow conversation.

For provider actions, search by intent and inspect the exact schema before execution:

```bash
smallforce integrations tools search "send an email"
smallforce integrations tools get GMAIL_SEND_EMAIL --json
smallforce integrations tools execute GMAIL_SEND_EMAIL \
  --connection <connectionId> \
  --input '{"to":"customer@example.com","subject":"Hello","body":"Hi"}'
```

Require approval for sensitive communications, destructive actions, financial changes, or any other action covered by organization policy. See the complete [`smallforce integrations` reference](/docs/cli/commands/integrations).

---

<!-- source: agency-guides/launch-client-website -->

# Launch a client website with a SmallForce AI employee

Create a client folder containing the approved brief, brand assets, services, contact details, legal requirements, and reference material. Ask the website employee to read those sources before proposing structure or copy.

Use the [website creation workflow](/docs/websites/create) to initialize the project. Review the first preview for factual accuracy, responsive behavior, calls to action, forms, accessibility, and brand fit. Keep feedback in the project conversation.

Before deployment:

- Confirm every business claim and contact detail.
- Test navigation, forms, and important outbound links.
- Verify mobile layouts and meaningful image alternatives.
- Confirm the intended access mode.
- Separate server variables from write-only secrets.
- Build and review the release output.

Deploy the release, inspect its status, and review the public URL. Use logs and diagnostics for runtime failures and analytics for post-launch behavior. Save launch decisions and client approval with the project rather than relying on chat memory alone.

---

<!-- source: meetings/record-on-mobile -->

# Record and transcribe a meeting on mobile

Open **Meetings** in the SmallForce mobile app and select **Record meeting**.

## Before recording

- Confirm the correct SmallForce organization is selected.
- Tell participants that the meeting will be recorded when consent is required.
- Grant microphone permission when prompted.
- Check available storage and battery for a long meeting.

## During the meeting

Use the recording bar to pause, resume, finish, or discard the recording. On supported iPhones, a Live Activity can show the recording state while SmallForce is in the background. The mobile recorder supports background recording after permission is enabled.

## After the meeting

When you finish, SmallForce saves a recoverable local recording before attempting upload. Keep the app connected until upload completes. After the recording reaches the organization, transcription begins or can be retried from the meeting.

Open the meeting to play the audio, read the transcript, or retry a failed upload or transcription. Once the transcript is available, ask an employee to produce a summary, decisions, owners, deadlines, risks, or follow-up messages.

Do not permanently delete the local copy until the uploaded meeting and transcript are visible in SmallForce.

---

<!-- source: calls/recordings-and-follow-up -->

# Search call recordings and transcripts for follow-up

Call history can turn customer conversations into operational knowledge when recording and transcription are enabled for the organization.

Use transcript search to find calls that mentioned a service, competitor, pricing question, complaint, or other business topic. Open the full transcript or recording before relying on an excerpt, especially when tone, qualification, or exact wording matters.

Employees can help:

- Summarize why the customer called.
- Identify a lead, support issue, or escalation.
- Extract promised follow-up without inventing commitments.
- Draft a reply for an authorized person to review.
- Compare recurring questions across multiple calls.
- Turn approved insights into updated workspace knowledge.

Restrict call data to people and employees with a legitimate business need. Follow recording-consent, retention, and deletion requirements that apply to the business and caller location.

---

<!-- source: workspace/search -->

# Search files and business knowledge in SmallForce

[Workspace search](/company-brain) helps people and employees find relevant source material without knowing the exact filename or wording in advance.

## Search effectively

Use a phrase that identifies the information you need:

- “Northwind cancellation policy”
- “campaigns where cost per lead exceeded $40”
- “client feedback about the homepage headline”
- “meeting where we agreed on the launch date”

Search can match exact terms and related meaning. When several clients use similar language, narrow the search to the relevant client or project folder.

## Read the source

A search result is a discovery aid. Open the source file or ask the employee to read the relevant document before relying on a short result excerpt. This is particularly important for policies, contracts, spreadsheets, and long meeting transcripts.

## When a file is missing from results

1. Confirm the file is inside the current organization’s workspace.
2. Check whether its type is supported.
3. Review the file’s indexing status.
4. Retry after indexing completes.
5. Replace damaged or password-protected documents with a readable copy.

Updating a file causes its searchable representation to be refreshed. Removing a file removes it from normal workspace use after the change is processed.

---

<!-- source: start/set-up-smallforce -->

# Set up SmallForce for your organization

Use this sequence for a new organization or client account.

## 1. Confirm the organization

Select the organization you want to work in before adding employees, files, channels, or connected accounts. Organization-owned resources stay associated with that organization.

Technical users can verify the organization attached to an API key with:

```bash
smallforce org get
```

## 2. Prepare an employee

Choose the employee that will own the first workflow. Give it a clear role, describe the result it is responsible for, and provide any operating constraints it should consistently follow. See [AI employees](/docs/employees/overview).

## 3. Add business knowledge

Upload the documents the employee should use: brand guidance, service descriptions, client notes, policies, research, spreadsheets, or existing content. SmallForce indexes supported files so they can be searched from the workspace. See [workspace search](/docs/workspace/search).

## 4. Connect where work happens

Connect [Slack or Telegram](/docs/channels/overview) when a team wants to work with employees from an existing communication channel. Connect external applications through [integrations](/docs/integrations/overview) when the employee needs to react to events or execute provider tools.

## 5. Give a concrete first task

Start with an outcome that can be verified, such as:

- “Use our brand files to draft next week’s social posts.”
- “Create a website for this client and deploy a preview.”
- “Review this meeting transcript and list every commitment.”
- “Research competing local businesses and save the findings.”

Add the relevant files and expected deliverable. The employee can ask for missing information before acting.

---

<!-- source: apps/mobile -->

# SmallForce mobile app for iOS and Android

The [mobile app](/ai-assistant-app) keeps employees and organization work available away from a desk. Sign in, select the intended organization, and choose an employee or existing conversation.

## Work with employees

Use the mobile composer to send instructions and supported attachments. Follow the live task state while an employee works, steer the employee when new information changes the request, and review the final result from the same conversation.

Use a new conversation for unrelated work. Continue an existing one when the employee needs its decisions and progress.

## Record meetings

The mobile app includes a meeting recorder for iOS and Android. It can record microphone audio in the background after permission is granted, pause and resume a recording, save it locally, upload it to the selected organization, and request a transcript. See [record a meeting on mobile](/docs/meetings/record-on-mobile).

On supported iPhones, Live Activities can keep active employee work or meeting recording status visible outside the foreground app.

## Apple Watch

Pair the mobile app with [Apple Watch](/docs/apps/apple-watch) for quick voice requests and employee access. The paired phone manages the Watch connection.

---

<!-- source: cli/commands/org/get -->

# `smallforce org get`

Get organization details

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce org get --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce org get [options]

Get organization details

Options:
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  -h, --help           display help for command
```

## Related reference

- [`smallforce org`](/docs/cli/commands/org): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: employees/instructions -->

# Write effective instructions for an AI employee

Good instructions make an employee predictable without trying to script every possible task. Write them as an operating charter.

## Recommended structure

1. **Role:** Name the business function, such as client website producer, social media operator, or campaign analyst.
2. **Primary outcomes:** State what the employee is responsible for delivering.
3. **Trusted sources:** Point to workspace folders, connected accounts, or approved references.
4. **Decision boundaries:** Identify changes that require approval, especially publishing, spending, deleting, or contacting customers.
5. **Working style:** Explain how to report progress, uncertainty, and blockers.
6. **Completion:** Define what evidence shows the task is finished.

## Example

> You operate social media for Northwind Dental. Use the current brand guide and service information from the Northwind workspace. Prepare platform-appropriate content, validate every publication, and present scheduled dates before publishing. Never invent an offer, testimonial, or clinical claim. Report the resulting post IDs and publication status when work is complete.

Do not place credentials, API keys, or other secrets in employee instructions. Use the supported connection and secret-management surfaces instead.

Review instructions when the employee’s responsibilities change. Use the conversation for temporary requests and the [workspace](/docs/workspace/overview) for source documents that should remain searchable.

---

<!-- source: cli/json-output -->

# Use SmallForce CLI JSON output in agents and scripts

Commands print human-readable text by default. Add `--json` when an agent or script needs stable machine-readable output:

```bash
smallforce org get --json
smallforce social accounts list --json
smallforce app diagnostics --days 7 --json
```

## Reliable automation rules

- Parse the JSON envelope instead of terminal prose.
- Discover organization-owned IDs from list, search, or get commands.
- Never invent provider IDs, SmallForce IDs, event slugs, or tool slugs.
- Read the leaf command’s current `--help` before a mutation.
- Build structured inputs from schemas returned by discovery commands.
- Use `--input-file -` when a supported command should receive large or sensitive JSON through stdin.
- Validate social posts and advertising campaigns before creation when validation is available.
- Use idempotency controls when retrying could create duplicates.
- Inspect the returned next step and terminal status rather than assuming asynchronous work succeeded.

The generated [command reference](/docs/cli/commands) includes every current command and its complete help text for SmallForce CLI 0.1.6.

---

<!-- source: channels/telegram -->

# Connect SmallForce AI employees to Telegram

Telegram groups can provide a shared place for a team to work with SmallForce employees. Topics keep different employees and workstreams separate.

## Connect a group

1. Open **Channels → Telegram** in SmallForce.
2. Start the connection flow and open the generated Telegram link.
3. Add or authorize SmallForce in the intended group.
4. Return to SmallForce and confirm the pending group connection.

Connection links are temporary. Start a new connection flow if the link expires before setup is completed.

## Organize work with topics

Create a topic for an employee and give it a recognizable title such as “Content · Acme” or “Client reporting.” Messages inside that topic go to the selected employee. Start another topic for unrelated work or a different employee.

## Choose reply visibility

Telegram supports final-only, compact, and detailed progress. Final-only is quietest; compact provides useful milestones; detailed is suited to work where the group needs to observe intermediate activity.

Owners and admins manage group connections. If messages are not handled, confirm the group is active, the topic has an available employee, and the SmallForce organization is ready.

---

<!-- source: websites/deploy-and-operate -->

# Deploy and operate a SmallForce website

A SmallForce deployment creates an immutable release from the project’s build output, uploads it, and waits until Preview serves it. Run deployment from an existing Vite SPA or a project already containing `smallforce.json`. The first deployment of a Vite SPA detects its build and creates the static project manifest automatically.

```bash
smallforce app deploy
smallforce app status
smallforce app release list
smallforce app env list
```

The application is the stable website identity. Releases are immutable code and
assets. Preview, Production, and optional custom environments are stable URLs
that point to a ready release. Promote the reviewed release without rebuilding:

```bash
smallforce app env deploy production --release <releaseId>
```

Promotion and rollback move only the environment pointer. Each environment
keeps its own variables, secrets, SQLite data, mutable files, and observability.

## Operate the deployed application

The application tools can inspect:

- Release history and the release currently active in each environment.
- Runtime logs over a selected time range.
- Human traffic and crawler traffic.
- Requests, failures, rate limits, and runtime diagnostics.
- Application database schema and queries.
- Mutable application files and storage usage.

Select the environment when inspecting runtime data. Reads default to Preview;
database and configuration mutations require an explicit environment:

```bash
smallforce app inspect --environment preview --json
smallforce app analytics --environment production --days 30 --json
smallforce app var set API_URL https://api.example.com --environment preview
```

Use server variables for non-secret runtime configuration and write-only secrets for credentials. Secret values are not returned after being stored.

## Control access

A generated application can be public, protected by a shared password, restricted to an allowlist of Google member emails, or use organization SSO. Preview and custom URLs first require SmallForce organization membership, then run the same application access policy so authentication can be tested before Production promotion.

See the complete [`smallforce app` reference](/docs/cli/commands/app) for every deployment, database, file, environment, observability, and access command.

---

<!-- source: advertising/leads-and-performance -->

# Manage Meta lead forms, leads, and ad performance

SmallForce can list, inspect, create, archive, and test supported Meta Instant Forms. Test a form before using it in a live campaign and verify the downstream follow-up workflow receives the expected fields.

Use `ads leads list` to retrieve captured leads for the selected ad account. Treat lead information as customer data: limit access, avoid copying it into unrelated workspaces, and follow the organization’s retention and contact policies.

Campaign browsing and analytics can show campaign trees, nested objects, and performance over the requested scope. Ask an employee to explain the metric window and source before comparing campaigns with different objectives or attribution conditions.

Useful agency workflows include:

- Alerting the appropriate employee when a new lead arrives.
- Enriching the lead with approved connected tools.
- Drafting a personalized response for review.
- Tracking response status and next action.
- Summarizing campaign performance without changing spend.

Use the [`smallforce ads lead-forms` reference](/docs/cli/commands/ads/lead-forms), [`ads leads`](/docs/cli/commands/ads/leads), and [`ads campaigns analytics`](/docs/cli/commands/ads/campaigns/analytics) for exact inputs.

---

<!-- source: meetings/search-and-follow-up -->

# Search meeting transcripts and create follow-up work

Once transcription completes, a meeting becomes part of the organization’s searchable knowledge.

Search with the business question you are trying to answer rather than only the meeting title:

- “When did the client approve the homepage?”
- “Which launch risks did we discuss?”
- “Meetings that mentioned a budget above $5,000.”
- “Who agreed to prepare the campaign assets?”

Open the matching transcript before relying on exact wording. A short search excerpt may omit qualifications or surrounding discussion.

## Useful employee tasks

- Summarize the meeting for a client or internal team.
- Extract decisions separately from suggestions.
- Create action items with owners and dates.
- Draft follow-up email without inventing commitments.
- Compare this meeting with an earlier brief.
- Add approved information to a project plan.

Include the intended audience and output format in the request. Ask the employee to cite or quote the transcript when accuracy is important.

---

<!-- source: apps/desktop -->

# SmallForce desktop app for macOS

The desktop app provides a desktop-first SmallForce workspace without copying the web dashboard experience. Use it for employee conversations, files, generated website projects, and other work that benefits from a persistent desktop window.

Select the correct organization and workspace before starting a task. Files added through the desktop experience become available through the same organization workspace and searchable knowledge surfaces.

## Meeting recording on macOS

On supported macOS systems, SmallForce can record microphone audio and meeting audio playing on the Mac after the required permissions are granted. Screen video is not saved. Completed recordings can be uploaded, transcribed, reviewed, and deleted from the meeting experience.

Recording availability and permission behavior depend on the operating system. Follow the in-app permission guidance, confirm local recording controls before a meeting starts, and comply with applicable consent laws.

See [meeting recording and transcription](/docs/meetings/overview) for the shared meeting workflow.

---

<!-- source: cli/commands/employees -->

# `smallforce employees`

Discover the AI employees available in this organization's OS

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce employees --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce employees list`](/docs/cli/commands/employees/list): List active AI employees and their stable slugs

## Complete command help

```text
Usage: smallforce employees [options] [command]

Discover the AI employees available in this organization's OS

Options:
  -h, --help      display help for command

Commands:
  list [options]  List active AI employees and their stable slugs
  help [command]  display help for command
```

## Related reference

- [`smallforce`](/docs/cli/commands): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: integrations/chatgpt-claude-codex -->

# Use SmallForce in ChatGPT, Claude, and Codex

SmallForce exposes a remote Model Context Protocol (MCP) service. A connection
is bound to one organization selected during SmallForce OAuth. The client never
chooses an organization by sending an ID with a tool call.

## Connect safely

1. Add the official SmallForce connector or MCP server in the AI client.
2. Sign in to SmallForce and select one organization.
3. Review the requested permission groups. Files, email, calls, and advertising
   are read only. Social access can save private drafts. Employee chat is its
   own permission.
4. Begin with company status or another read-only request.

SmallForce rechecks the bearer token, current organization membership, role,
plan, Company OS readiness, and required scope on delegated calls. An internal
service credential cannot select a user or organization by itself.

## What the assistant can do

- **Company:** check your plan and whether your Company OS is ready.
- **Calls:** list recent calls and open one call's transcript, summary, and
  outcome. Recordings play inside the rendered view.
- **Files:** browse, search, and read files in your Company OS workspace.
- **Email:** read your SmallForce-managed mailboxes: the newest conversations,
  a whole thread, or one message.
- **Employees:** list your AI employees and chat with one of them.
- **Social:** compare account performance, open one post's analytics, find
  your strongest posting times, list existing posts, and compose a post with
  media that is saved as a private draft.
- **Advertising:** a performance report across your Meta, Google, and TikTok
  accounts.

## What stays in SmallForce HQ

The connection does not send or reply to email, publish or schedule posts,
write files, connect accounts, create employees, or change ad campaigns. Ask
the assistant for a reply and it drafts the text for you to send from
SmallForce HQ. Ask it to publish a post and it saves a private draft you can
publish or schedule from HQ.

## Chatting with an employee

An employee chat is an ordinary chat your team can see in SmallForce HQ. The
employee works with the access your business gave it, the same as when you ask
it in HQ, so it can change files or act in connected apps when that access
allows. The assistant confirms each task with you before handing it over, and
the employee can decline when your business does not let you ask it. You can
stop a running task from the chat view.

## Rich views and ordinary tool results

Compatible hosts can render SmallForce views for company status, calls, files,
email, employees, social, and advertising. The same tools also return concise
text and typed structured data, so the workflows remain usable when a host does
not render a view. A host's surrounding chat composer is part of that host, not
the SmallForce view: you continue an employee chat by writing there.

## Revoke access

Remove SmallForce from the AI client's connector settings or revoke the client
in SmallForce. See [SmallForce support](/support) for connection
troubleshooting and deletion requests.

---

<!-- source: social-media/engagement-and-analytics -->

# Manage social inbox, reviews, and analytics

SmallForce can bring supported social conversations and reviews into the same operating workflow used for publishing.

## Inbox

List conversations, inspect their messages, mark conversations as read, and send supported text or rich messages. Resolve the conversation and account from SmallForce before replying. Give employees clear escalation rules for refunds, legal threats, sensitive personal information, or commitments outside approved policy.

## Reviews

List and inspect supported Facebook and Google Business reviews, create a reply, or remove an existing reply where supported. Ground responses in the business’s approved service information. Do not invent a customer history or claim that an issue was resolved when it was not.

## Synchronization

Refresh account, profile, post, or external-post state when provider changes are not yet reflected. Synchronization imports provider state; it is not a substitute for checking a mutation result.

## Analytics

Analytics covers daily performance, best-time analysis, content decay, posting frequency, followers, post timelines, and provider-specific metrics for Facebook, Instagram, YouTube, TikTok, and LinkedIn. Use the leaf command’s current help for metric names, date limits, and supported breakdowns.

See the complete [`smallforce social` reference](/docs/cli/commands/social).

---

<!-- source: workspace/supported-files -->

# Supported files for SmallForce workspace search

SmallForce can index readable text from common business files, including Markdown, plain text, PDFs, word-processing documents, and spreadsheets. Meeting transcripts and other text saved into the workspace can be searched alongside uploaded files.

## Prepare useful source files

- Prefer text-based PDFs over image-only scans.
- Use descriptive filenames and folder names.
- Keep headings and table labels meaningful.
- Remove duplicate exports when they contain the same information.
- Split unrelated client material into separate folders.
- Avoid password-protected files unless you first create a readable copy.

Spreadsheets are most useful when columns have clear headers and cells contain values rather than relying entirely on visual formatting. Documents are most useful when important facts appear as real text rather than text embedded in images.

Large files can take longer to become searchable. Search results should always be treated as a pointer to the source; open the document when exact wording, complete tables, or surrounding context matters.

If a file cannot be indexed, it can still remain in the workspace as a project asset, but employees may need a readable companion document to search its contents.

---

<!-- source: cli/commands/employees/list -->

# `smallforce employees list`

List active AI employees and their stable slugs

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce employees list --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce employees list [options]

List active AI employees and their stable slugs

Options:
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  -h, --help           display help for command
```

## Related reference

- [`smallforce employees`](/docs/cli/commands/employees): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: apps/apple-watch -->

# Use SmallForce AI employees from Apple Watch

The SmallForce Apple Watch experience is designed for quick, voice-first access to an employee when using a phone or computer is inconvenient.

## Get ready

1. Sign in to the SmallForce mobile app on the paired iPhone.
2. Select the organization you want the Watch to use.
3. Open the Watch setup experience in the mobile app and confirm the available employees.
4. Open SmallForce on Apple Watch and select an employee.

## Send a voice request

Record a clear request and send it from the Watch. SmallForce transcribes the request, delivers it to the selected employee, and returns the result through the supported Watch experience. Follow-up requests can continue the employee’s Watch conversation.

Use the iPhone app to refresh the pairing or employee list if the Watch is out of date. Watch access is intentionally short-lived and may need to be renewed from the paired phone.

For longer prompts, attached files, or detailed review, continue in the [mobile app](/docs/apps/mobile) or another SmallForce app.

---

<!-- source: cli/commands/chat -->

# `smallforce chat`

Talk to AI employees in chats

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce chat --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce chat send`](/docs/cli/commands/chat/send): Start or continue a chat with an AI employee
- [`smallforce chat list`](/docs/cli/commands/chat/list): List chats
- [`smallforce chat get`](/docs/cli/commands/chat/get): Inspect one chat
- [`smallforce chat messages`](/docs/cli/commands/chat/messages): Read a chat's messages
- [`smallforce chat watch`](/docs/cli/commands/chat/watch): Follow the work running in a chat until it finishes
- [`smallforce chat abort`](/docs/cli/commands/chat/abort): Explicitly stop an employee's current work in a chat

## Complete command help

```text
Usage: smallforce chat [options] [command]

Talk to AI employees in chats

Options:
  -h, --help                   display help for command

Commands:
  send [options] <message>     Start or continue a chat with an AI employee
  list [options]               List chats
  get [options] <chatId>       Inspect one chat
  messages [options] <chatId>  Read a chat's messages
  watch [options] <chatId>     Follow the work running in a chat until it finishes
  abort [options] <chatId>     Explicitly stop an employee's current work in a chat
  help [command]               display help for command
```

## Related reference

- [`smallforce`](/docs/cli/commands): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/chat/send -->

# `smallforce chat send`

Start or continue a chat with an AI employee

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce chat send --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce chat send [options] <message>

Start or continue a chat with an AI employee

Arguments:
  message              Task or follow-up message

Options:
  --employee <slug>    Start a new chat with this employee
  --chat <chatId>      Continue this chat
  --wait               Follow the chat until the employee replies
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  -h, --help           display help for command
```

## Related reference

- [`smallforce chat`](/docs/cli/commands/chat): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/chat/list -->

# `smallforce chat list`

List chats

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce chat list --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce chat list [options]

List chats

Options:
  --employee <slug>    Only chats this employee is in
  --cursor <cursor>    Continue from a previous nextCursor
  --limit <count>      Chats to return, 1-100
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  -h, --help           display help for command
```

## Related reference

- [`smallforce chat`](/docs/cli/commands/chat): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/chat/get -->

# `smallforce chat get`

Inspect one chat

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce chat get --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce chat get [options] <chatId>

Inspect one chat

Arguments:
  chatId               Chat id

Options:
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  -h, --help           display help for command
```

## Related reference

- [`smallforce chat`](/docs/cli/commands/chat): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/chat/messages -->

# `smallforce chat messages`

Read a chat's messages

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce chat messages --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce chat messages [options] <chatId>

Read a chat's messages

Arguments:
  chatId               Chat id

Options:
  --cursor <cursor>    Continue from a previous nextCursor
  --limit <count>      Messages to return, 1-100
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  -h, --help           display help for command
```

## Related reference

- [`smallforce chat`](/docs/cli/commands/chat): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/chat/watch -->

# `smallforce chat watch`

Follow the work running in a chat until it finishes

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce chat watch --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce chat watch [options] <chatId>

Follow the work running in a chat until it finishes

Arguments:
  chatId               Chat id

Options:
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  -h, --help           display help for command
```

## Related reference

- [`smallforce chat`](/docs/cli/commands/chat): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands -->

# `smallforce`

SmallForce CLI for agents and humans working with AI employees, the company workspace, generated apps, integrations, social media, advertising, calls, SEO, and AI media.

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce org`](/docs/cli/commands/org): Inspect the SmallForce organization for this API key
- [`smallforce employees`](/docs/cli/commands/employees): Discover the AI employees available in this organization's OS
- [`smallforce chat`](/docs/cli/commands/chat): Talk to AI employees in chats
- [`smallforce calls`](/docs/cli/commands/calls): Manage assistants, publishing, personal audio/video links, numbers and call history
- [`smallforce workspace`](/docs/cli/commands/workspace): Search, read, and write UTF-8 text in the organization's OS workspace
- [`smallforce app`](/docs/cli/commands/app): Initialize, deploy, inspect, and protect a generated application
- [`smallforce integrations`](/docs/cli/commands/integrations): Manage integration accounts, incoming events, and executable integration tools
- [`smallforce media`](/docs/cli/commands/media): Generate images, video, and audio with AI models
- [`smallforce assets`](/docs/cli/commands/assets): Upload and manage organization-owned files used across SmallForce
- [`smallforce social`](/docs/cli/commands/social): Connect social accounts, publish content, manage comments, inbox and reviews, and inspect analytics
- [`smallforce ads`](/docs/cli/commands/ads): Manage Meta, Google, and TikTok Ads through organization-scoped SmallForce resources
- [`smallforce seo`](/docs/cli/commands/seo): Discover and run SEO, local-search, and AI-search research capabilities
- [`smallforce scrapers`](/docs/cli/commands/scrapers): Discover and run curated web and social scrapers
- [`smallforce gmb`](/docs/cli/commands/gmb): Manage Google Business Profile locations, media, actions, and analytics

## Complete command help

```text
Usage: smallforce [options] [command]

SmallForce CLI for agents and humans working with AI employees, the company workspace, generated
apps, integrations, social media, advertising, calls, SEO, and AI media.

Options:
  -V, --version        output the version number
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  -h, --help           display help for command

Commands:
  org                  Inspect the SmallForce organization for this API key
  employees            Discover the AI employees available in this organization's OS
  chat                 Talk to AI employees in chats
  calls [options]      Manage assistants, publishing, personal audio/video links, numbers and call
                       history
  workspace            Search, read, and write UTF-8 text in the organization's OS workspace
  app                  Initialize, deploy, inspect, and protect a generated application
  integrations         Manage integration accounts, incoming events, and executable integration
                       tools
  media                Generate images, video, and audio with AI models
  assets               Upload and manage organization-owned files used across SmallForce
  social               Connect social accounts, publish content, manage comments, inbox and reviews,
                       and inspect analytics
  ads                  Manage Meta, Google, and TikTok Ads through organization-scoped SmallForce
                       resources
  seo                  Discover and run SEO, local-search, and AI-search research capabilities
  scrapers             Discover and run curated web and social scrapers
  gmb                  Manage Google Business Profile locations, media, actions, and analytics
  help [command]       display help for command
```

---

<!-- source: cli/commands/chat/abort -->

# `smallforce chat abort`

Explicitly stop an employee's current work in a chat

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce chat abort --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce chat abort [options] <chatId>

Explicitly stop an employee's current work in a chat

Arguments:
  chatId               Chat id

Options:
  --employee <slug>    The employee to stop (default: the chat's default employee)
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  -h, --help           display help for command
```

## Related reference

- [`smallforce chat`](/docs/cli/commands/chat): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/calls -->

# `smallforce calls`

Manage assistants, publishing, personal audio/video links, numbers and call history

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce calls --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce calls credits`](/docs/cli/commands/calls/credits): Show the existing SmallForce credit balance
- [`smallforce calls list`](/docs/cli/commands/calls/list): List call history, newest first
- [`smallforce calls get`](/docs/cli/commands/calls/get): Get a call with events, transcripts and recording details
- [`smallforce calls events`](/docs/cli/commands/calls/events): Read the call's lifecycle events
- [`smallforce calls transcripts`](/docs/cli/commands/calls/transcripts): Read call transcripts
- [`smallforce calls recording`](/docs/cli/commands/calls/recording): Get the existing recording's temporary playback URL, when available
- [`smallforce calls voices`](/docs/cli/commands/calls/voices): Discover the voice service's TTS voice catalog
- [`smallforce calls publish`](/docs/cli/commands/calls/publish): Configure regular assistants' public pages and website embeds
- [`smallforce calls links`](/docs/cli/commands/calls/links): Manage personalized audio/video call invitations for regular assistants
- [`smallforce calls answers`](/docs/cli/commands/calls/answers): Read collected answers, field definitions and missing required fields
- [`smallforce calls video`](/docs/cli/commands/calls/video): Discover available video avatars and voices
- [`smallforce calls assistants`](/docs/cli/commands/calls/assistants): Manage voice assistant configuration
- [`smallforce calls phone-numbers`](/docs/cli/commands/calls/phone-numbers): Search, purchase and manage inbound phone numbers
- [`smallforce calls knowledge`](/docs/cli/commands/calls/knowledge): Manage the existing voice knowledge and training jobs

## Complete command help

```text
Usage: smallforce calls [options] [command]

Manage assistants, publishing, personal audio/video links, numbers and call history

Options:
  --api-key <key>                 SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>             SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                          Print stable machine-readable JSON
  --text                          Print human-readable text
  --format <format>               Output format: text or json
  -h, --help                      display help for command

Commands:
  credits [options]               Show the existing SmallForce credit balance
  list [options]                  List call history, newest first
  get [options] <callId>          Get a call with events, transcripts and recording details
  events [options] <callId>       Read the call's lifecycle events
  transcripts [options] <callId>  Read call transcripts
  recording [options] <callId>    Get the existing recording's temporary playback URL, when
                                  available
  voices [options]                Discover the voice service's TTS voice catalog
  publish [options]               Configure regular assistants' public pages and website embeds
  links [options]                 Manage personalized audio/video call invitations for regular
                                  assistants
  answers [options] <callId>      Read collected answers, field definitions and missing required
                                  fields
  video [options]                 Discover available video avatars and voices
  assistants [options]            Manage voice assistant configuration
  phone-numbers [options]         Search, purchase and manage inbound phone numbers
  knowledge [options]             Manage the existing voice knowledge and training jobs
  help [command]                  display help for command
```

## Related reference

- [`smallforce`](/docs/cli/commands): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/calls/credits -->

# `smallforce calls credits`

Show the existing SmallForce credit balance

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce calls credits --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce calls credits [options]

Show the existing SmallForce credit balance

Options:
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  -h, --help           display help for command
```

## Related reference

- [`smallforce calls`](/docs/cli/commands/calls): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/calls/list -->

# `smallforce calls list`

List call history, newest first

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce calls list --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce calls list [options]

List call history, newest first

Options:
  --api-key <key>         SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>     SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                  Print stable machine-readable JSON
  --text                  Print human-readable text
  --format <format>       Output format: text or json
  --assistant-id <id>     Filter by voice assistant
  --channel <channel>     Filter channel (choices: "phone", "web")
  --cursor <cursor>       Opaque nextCursor from the previous page
  --include-deleted       Include deleted calls
  --limit <number>        Maximum calls (1-200)
  --status <statuses...>  Filter call statuses (choices: "created", "connecting", "active",
                          "ending", "call_completed", "recording_processing",
                          "transcript_finalizing", "analysis_queued", "analysis_running",
                          "analysis_completed", "completed", "failed", "rejected", "expired")
  --tag-id <ids...>       Filter by existing tag IDs
  -h, --help              display help for command
```

## Related reference

- [`smallforce calls`](/docs/cli/commands/calls): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/calls/get -->

# `smallforce calls get`

Get a call with events, transcripts and recording details

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce calls get --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce calls get [options] <callId>

Get a call with events, transcripts and recording details

Options:
  --api-key <key>              SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>          SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                       Print stable machine-readable JSON
  --text                       Print human-readable text
  --format <format>            Output format: text or json
  --event-limit <number>       Maximum events (1-5000)
  --transcript-limit <number>  Maximum transcript entries (1-5000)
  -h, --help                   display help for command
```

## Related reference

- [`smallforce calls`](/docs/cli/commands/calls): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/calls/events -->

# `smallforce calls events`

Read the call's lifecycle events

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce calls events --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce calls events [options] <callId>

Read the call's lifecycle events

Options:
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  --limit <number>     Maximum events (1-5000)
  -h, --help           display help for command
```

## Related reference

- [`smallforce calls`](/docs/cli/commands/calls): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/calls/transcripts -->

# `smallforce calls transcripts`

Read call transcripts

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce calls transcripts --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce calls transcripts [options] <callId>

Read call transcripts

Options:
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  --limit <number>     Maximum transcript entries (1-5000)
  -h, --help           display help for command
```

## Related reference

- [`smallforce calls`](/docs/cli/commands/calls): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/calls/recording -->

# `smallforce calls recording`

Get the existing recording's temporary playback URL, when available

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce calls recording --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce calls recording [options] <callId>

Get the existing recording's temporary playback URL, when available

Options:
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  -h, --help           display help for command
```

## Related reference

- [`smallforce calls`](/docs/cli/commands/calls): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/calls/voices -->

# `smallforce calls voices`

Discover the voice service's TTS voice catalog

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce calls voices --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce calls voices list`](/docs/cli/commands/calls/voices/list): List available TTS voices
- [`smallforce calls voices languages`](/docs/cli/commands/calls/voices/languages): List languages available in the voice catalog

## Complete command help

```text
Usage: smallforce calls voices [options] [command]

Discover the voice service's TTS voice catalog

Options:
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  -h, --help           display help for command

Commands:
  list [options]       List available TTS voices
  languages [options]  List languages available in the voice catalog
  help [command]       display help for command
```

## Related reference

- [`smallforce calls`](/docs/cli/commands/calls): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/calls/voices/list -->

# `smallforce calls voices list`

List available TTS voices

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce calls voices list --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce calls voices list [options]

List available TTS voices

Options:
  --api-key <key>        SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>    SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                 Print stable machine-readable JSON
  --text                 Print human-readable text
  --format <format>      Output format: text or json
  --provider <provider>  Voice provider (choices: "deepgram", "cartesia", "openai", "google")
  --language <language>  Filter language
  --search <text>        Search voices
  --limit <number>       Maximum voices (1-1000)
  -h, --help             display help for command
```

## Related reference

- [`smallforce calls voices`](/docs/cli/commands/calls/voices): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/calls/voices/languages -->

# `smallforce calls voices languages`

List languages available in the voice catalog

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce calls voices languages --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce calls voices languages [options]

List languages available in the voice catalog

Options:
  --api-key <key>        SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>    SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                 Print stable machine-readable JSON
  --text                 Print human-readable text
  --format <format>      Output format: text or json
  --provider <provider>  Voice provider (choices: "deepgram", "cartesia", "openai", "google")
  -h, --help             display help for command
```

## Related reference

- [`smallforce calls voices`](/docs/cli/commands/calls/voices): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/calls/publish -->

# `smallforce calls publish`

Configure regular assistants' public pages and website embeds

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce calls publish --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce calls publish get`](/docs/cli/commands/calls/publish/get): Read publishing settings, embed experience and collection fields
- [`smallforce calls publish update`](/docs/cli/commands/calls/publish/update): Patch publishing settings; omitted fields are preserved and experience is replaced as a whole
- [`smallforce calls publish install`](/docs/cli/commands/calls/publish/install): Get the public URL, floating widget and inline snippets with availability settings

## Complete command help

```text
Usage: smallforce calls publish [options] [command]

Configure regular assistants' public pages and website embeds

Options:
  --api-key <key>                  SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>              SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                           Print stable machine-readable JSON
  --text                           Print human-readable text
  --format <format>                Output format: text or json
  -h, --help                       display help for command

Commands:
  get [options] <assistantId>      Read publishing settings, embed experience and collection fields
  update [options] <assistantId>   Patch publishing settings; omitted fields are preserved and
                                   experience is replaced as a whole
  install [options] <assistantId>  Get the public URL, floating widget and inline snippets with
                                   availability settings
  help [command]                   display help for command
```

## Related reference

- [`smallforce calls`](/docs/cli/commands/calls): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/calls/publish/get -->

# `smallforce calls publish get`

Read publishing settings, embed experience and collection fields

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce calls publish get --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce calls publish get [options] <assistantId>

Read publishing settings, embed experience and collection fields

Options:
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  -h, --help           display help for command
```

## Related reference

- [`smallforce calls publish`](/docs/cli/commands/calls/publish): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/calls/publish/update -->

# `smallforce calls publish update`

Patch publishing settings; omitted fields are preserved and experience is replaced as a whole

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce calls publish update --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce calls publish update [options] <assistantId>

Patch publishing settings; omitted fields are preserved and experience is replaced as a whole

Options:
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  --input <json>       Full settings as a JSON object; explicit flags take precedence
  --input-file <path>  Read settings JSON from a file, or - for stdin
  -h, --help           display help for command
```

## Related reference

- [`smallforce calls publish`](/docs/cli/commands/calls/publish): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/calls/publish/install -->

# `smallforce calls publish install`

Get the public URL, floating widget and inline snippets with availability settings

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce calls publish install --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce calls publish install [options] <assistantId>

Get the public URL, floating widget and inline snippets with availability settings

Options:
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  -h, --help           display help for command
```

## Related reference

- [`smallforce calls publish`](/docs/cli/commands/calls/publish): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/calls/links -->

# `smallforce calls links`

Manage personalized audio/video call invitations for regular assistants

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce calls links --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce calls links create`](/docs/cli/commands/calls/links/create): Create a personal call link; reuse the idempotency key and input for retries
- [`smallforce calls links list`](/docs/cli/commands/calls/links/list): List link summaries and related calls; private context and bearer URLs are omitted
- [`smallforce calls links get`](/docs/cli/commands/calls/links/get): Get link details including private context
- [`smallforce calls links url`](/docs/cli/commands/calls/links/url): Explicitly retrieve the private bearer URL
- [`smallforce calls links revoke`](/docs/cli/commands/calls/links/revoke): Revoke a personalized invitation

## Complete command help

```text
Usage: smallforce calls links [options] [command]

Manage personalized audio/video call invitations for regular assistants

Options:
  --api-key <key>            SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>        SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                     Print stable machine-readable JSON
  --text                     Print human-readable text
  --format <format>          Output format: text or json
  -h, --help                 display help for command

Commands:
  create [options]           Create a personal call link; reuse the idempotency key and input for
                             retries
  list [options]             List link summaries and related calls; private context and bearer URLs
                             are omitted
  get [options] <linkId>     Get link details including private context
  url [options] <linkId>     Explicitly retrieve the private bearer URL
  revoke [options] <linkId>  Revoke a personalized invitation
  help [command]             display help for command
```

## Related reference

- [`smallforce calls`](/docs/cli/commands/calls): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/calls/links/create -->

# `smallforce calls links create`

Create a personal call link; reuse the idempotency key and input for retries

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce calls links create --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce calls links create [options]

Create a personal call link; reuse the idempotency key and input for retries

Options:
  --api-key <key>                   SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>               SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                            Print stable machine-readable JSON
  --text                            Print human-readable text
  --format <format>                 Output format: text or json
  --input <json>                    Full settings as a JSON object; explicit flags take precedence
  --input-file <path>               Read settings JSON from a file, or - for stdin
  --assistant-id <id>               Configured regular assistant
  --publication-id <id>             Saved design for this assistant (defaults to its default design)
  --title <title>                   Call title
  --recipient-name <name>           Recipient display name
  --recipient-email <email>         Email used for optional verification
  --customer-reference <reference>  Your customer identifier
  --context <content>               Private background for this conversation
  --context-file <path>             Read private context from a file, or - for stdin
  --modes <modes...>                Allowed call modes (choices: "audio", "video")
  --expires-at <timestamp>          ISO timestamp including timezone, within 90 days
  --expires-in <duration>           Relative expiry such as 30m, 12h or 7d
  --verify-email                    Require email verification before the call
  --idempotency-key <key>           Stable key for this creation request (required in flags or JSON)
  -h, --help                        display help for command
```

## Related reference

- [`smallforce calls links`](/docs/cli/commands/calls/links): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/calls/links/list -->

# `smallforce calls links list`

List link summaries and related calls; private context and bearer URLs are omitted

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce calls links list --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce calls links list [options]

List link summaries and related calls; private context and bearer URLs are omitted

Options:
  --api-key <key>                   SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>               SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                            Print stable machine-readable JSON
  --text                            Print human-readable text
  --format <format>                 Output format: text or json
  --assistant-id <id>               Filter assistant
  --customer-reference <reference>  Filter exact customer reference
  --status <status>                 Expiry/revocation state; unexpired links may already have a
                                    conversation (choices: "unexpired", "expired", "revoked")
  --limit <number>                  Page size (1-100)
  --cursor <cursor>                 Opaque nextCursor from the previous page
  -h, --help                        display help for command
```

## Related reference

- [`smallforce calls links`](/docs/cli/commands/calls/links): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/calls/links/get -->

# `smallforce calls links get`

Get link details including private context

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce calls links get --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce calls links get [options] <linkId>

Get link details including private context

Options:
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  -h, --help           display help for command
```

## Related reference

- [`smallforce calls links`](/docs/cli/commands/calls/links): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/calls/links/url -->

# `smallforce calls links url`

Explicitly retrieve the private bearer URL

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce calls links url --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce calls links url [options] <linkId>

Explicitly retrieve the private bearer URL

Options:
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  -h, --help           display help for command
```

## Related reference

- [`smallforce calls links`](/docs/cli/commands/calls/links): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/calls/links/revoke -->

# `smallforce calls links revoke`

Revoke a personalized invitation

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce calls links revoke --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce calls links revoke [options] <linkId>

Revoke a personalized invitation

Options:
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  -h, --help           display help for command
```

## Related reference

- [`smallforce calls links`](/docs/cli/commands/calls/links): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/calls/answers -->

# `smallforce calls answers`

Read collected answers, field definitions and missing required fields

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce calls answers --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce calls answers [options] <callId>

Read collected answers, field definitions and missing required fields

Options:
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  -h, --help           display help for command
```

## Related reference

- [`smallforce calls`](/docs/cli/commands/calls): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/calls/video -->

# `smallforce calls video`

Discover available video avatars and voices

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce calls video --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce calls video avatars`](/docs/cli/commands/calls/video/avatars): List available video avatars, defaults and duration limits
- [`smallforce calls video voices`](/docs/cli/commands/calls/video/voices): List available video voices, defaults and duration limits

## Complete command help

```text
Usage: smallforce calls video [options] [command]

Discover available video avatars and voices

Options:
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  -h, --help           display help for command

Commands:
  avatars [options]    List available video avatars, defaults and duration limits
  voices [options]     List available video voices, defaults and duration limits
  help [command]       display help for command
```

## Related reference

- [`smallforce calls`](/docs/cli/commands/calls): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/calls/video/avatars -->

# `smallforce calls video avatars`

List available video avatars, defaults and duration limits

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce calls video avatars --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce calls video avatars [options]

List available video avatars, defaults and duration limits

Options:
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  --assistant-id <id>  Include defaults for a regular assistant
  -h, --help           display help for command
```

## Related reference

- [`smallforce calls video`](/docs/cli/commands/calls/video): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/calls/video/voices -->

# `smallforce calls video voices`

List available video voices, defaults and duration limits

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce calls video voices --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce calls video voices [options]

List available video voices, defaults and duration limits

Options:
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  --assistant-id <id>  Include defaults for a regular assistant
  -h, --help           display help for command
```

## Related reference

- [`smallforce calls video`](/docs/cli/commands/calls/video): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/calls/assistants -->

# `smallforce calls assistants`

Manage voice assistant configuration

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce calls assistants --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce calls assistants fields`](/docs/cli/commands/calls/assistants/fields): Manage information a regular assistant collects naturally during calls
- [`smallforce calls assistants list`](/docs/cli/commands/calls/assistants/list): List voice assistants
- [`smallforce calls assistants create`](/docs/cli/commands/calls/assistants/create): Create a standalone or AI employee voice assistant
- [`smallforce calls assistants get`](/docs/cli/commands/calls/assistants/get): Get a voice assistant and its settings
- [`smallforce calls assistants update`](/docs/cli/commands/calls/assistants/update): Update selected assistant settings
- [`smallforce calls assistants delete`](/docs/cli/commands/calls/assistants/delete): Soft-delete a voice assistant

## Complete command help

```text
Usage: smallforce calls assistants [options] [command]

Manage voice assistant configuration

Options:
  --api-key <key>                 SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>             SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                          Print stable machine-readable JSON
  --text                          Print human-readable text
  --format <format>               Output format: text or json
  -h, --help                      display help for command

Commands:
  fields [options]                Manage information a regular assistant collects naturally during
                                  calls
  list [options]                  List voice assistants
  create [options]                Create a standalone or AI employee voice assistant
  get [options] <assistantId>     Get a voice assistant and its settings
  update [options] <assistantId>  Update selected assistant settings
  delete [options] <assistantId>  Soft-delete a voice assistant
  help [command]                  display help for command
```

## Related reference

- [`smallforce calls`](/docs/cli/commands/calls): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/calls/assistants/fields -->

# `smallforce calls assistants fields`

Manage information a regular assistant collects naturally during calls

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce calls assistants fields --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce calls assistants fields get`](/docs/cli/commands/calls/assistants/fields/get): Read collection field definitions
- [`smallforce calls assistants fields set`](/docs/cli/commands/calls/assistants/fields/set): Replace field definitions using {"fields":[...]}; an empty array disables collection

## Complete command help

```text
Usage: smallforce calls assistants fields [options] [command]

Manage information a regular assistant collects naturally during calls

Options:
  --api-key <key>              SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>          SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                       Print stable machine-readable JSON
  --text                       Print human-readable text
  --format <format>            Output format: text or json
  -h, --help                   display help for command

Commands:
  get [options] <assistantId>  Read collection field definitions
  set [options] <assistantId>  Replace field definitions using {"fields":[...]}; an empty array
                               disables collection
  help [command]               display help for command
```

## Related reference

- [`smallforce calls assistants`](/docs/cli/commands/calls/assistants): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/calls/assistants/fields/get -->

# `smallforce calls assistants fields get`

Read collection field definitions

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce calls assistants fields get --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce calls assistants fields get [options] <assistantId>

Read collection field definitions

Options:
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  -h, --help           display help for command
```

## Related reference

- [`smallforce calls assistants fields`](/docs/cli/commands/calls/assistants/fields): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/calls/assistants/fields/set -->

# `smallforce calls assistants fields set`

Replace field definitions using {"fields":[...]}; an empty array disables collection

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce calls assistants fields set --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce calls assistants fields set [options] <assistantId>

Replace field definitions using {"fields":[...]}; an empty array disables collection

Options:
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  --input <json>       Full settings as a JSON object; explicit flags take precedence
  --input-file <path>  Read settings JSON from a file, or - for stdin
  -h, --help           display help for command
```

## Related reference

- [`smallforce calls assistants fields`](/docs/cli/commands/calls/assistants/fields): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/calls/assistants/list -->

# `smallforce calls assistants list`

List voice assistants

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce calls assistants list --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce calls assistants list [options]

List voice assistants

Options:
  --api-key <key>         SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>     SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                  Print stable machine-readable JSON
  --text                  Print human-readable text
  --format <format>       Output format: text or json
  --include-deleted       Include deleted assistants
  --limit <number>        Maximum assistants (1-250)
  --status <statuses...>  Filter statuses (choices: "draft", "active", "paused", "archived")
  -h, --help              display help for command
```

## Related reference

- [`smallforce calls assistants`](/docs/cli/commands/calls/assistants): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/calls/assistants/create -->

# `smallforce calls assistants create`

Create a standalone or AI employee voice assistant

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce calls assistants create --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce calls assistants create [options]

Create a standalone or AI employee voice assistant

Options:
  --api-key <key>                   SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>               SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                            Print stable machine-readable JSON
  --text                            Print human-readable text
  --format <format>                 Output format: text or json
  --mode <mode>                     Assistant mode (choices: "standalone", "ai_employee")
  --employee-os <id>                Employee OS instance
  --employee-profile <slug>         Employee profile
  --input <json>                    Full settings as a JSON object; explicit flags take precedence
  --input-file <path>               Read settings JSON from a file, or - for stdin
  --max-duration-seconds <seconds>  Assistant call duration ceiling
  --name <name>                     Assistant name
  --progress <mode>                 Spoken progress level (choices: "final_only", "compact",
                                    "detailed")
  --status <status>                 Assistant status (choices: "draft", "active", "paused",
                                    "archived")
  --system-prompt <text>            Instructions used by the voice assistant
  --system-prompt-file <path>       Read instructions from a file, or - for stdin
  -h, --help                        display help for command
```

## Related reference

- [`smallforce calls assistants`](/docs/cli/commands/calls/assistants): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/calls/assistants/get -->

# `smallforce calls assistants get`

Get a voice assistant and its settings

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce calls assistants get --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce calls assistants get [options] <assistantId>

Get a voice assistant and its settings

Options:
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  -h, --help           display help for command
```

## Related reference

- [`smallforce calls assistants`](/docs/cli/commands/calls/assistants): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/calls/assistants/update -->

# `smallforce calls assistants update`

Update selected assistant settings

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce calls assistants update --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce calls assistants update [options] <assistantId>

Update selected assistant settings

Options:
  --api-key <key>                   SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>               SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                            Print stable machine-readable JSON
  --text                            Print human-readable text
  --format <format>                 Output format: text or json
  --input <json>                    Full settings as a JSON object; explicit flags take precedence
  --input-file <path>               Read settings JSON from a file, or - for stdin
  --max-duration-seconds <seconds>  Assistant call duration ceiling
  --name <name>                     Assistant name
  --progress <mode>                 Spoken progress level (choices: "final_only", "compact",
                                    "detailed")
  --status <status>                 Assistant status (choices: "draft", "active", "paused",
                                    "archived")
  --system-prompt <text>            Instructions used by the voice assistant
  --system-prompt-file <path>       Read instructions from a file, or - for stdin
  -h, --help                        display help for command
```

## Related reference

- [`smallforce calls assistants`](/docs/cli/commands/calls/assistants): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/calls/assistants/delete -->

# `smallforce calls assistants delete`

Soft-delete a voice assistant

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce calls assistants delete --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce calls assistants delete [options] <assistantId>

Soft-delete a voice assistant

Options:
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  -h, --help           display help for command
```

## Related reference

- [`smallforce calls assistants`](/docs/cli/commands/calls/assistants): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/calls/phone-numbers -->

# `smallforce calls phone-numbers`

Search, purchase and manage inbound phone numbers

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce calls phone-numbers --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce calls phone-numbers search`](/docs/cli/commands/calls/phone-numbers/search): Search available phone numbers
- [`smallforce calls phone-numbers list`](/docs/cli/commands/calls/phone-numbers/list): List purchased phone numbers and their billing status
- [`smallforce calls phone-numbers buy`](/docs/cli/commands/calls/phone-numbers/buy): Purchase a phone number; the service checks and charges credits
- [`smallforce calls phone-numbers get`](/docs/cli/commands/calls/phone-numbers/get): Get a purchased phone number
- [`smallforce calls phone-numbers attach`](/docs/cli/commands/calls/phone-numbers/attach): Attach a purchased number to a voice assistant
- [`smallforce calls phone-numbers detach`](/docs/cli/commands/calls/phone-numbers/detach): Detach a number from its assistant; keep the purchased number
- [`smallforce calls phone-numbers sync-webhooks`](/docs/cli/commands/calls/phone-numbers/sync-webhooks): Sync the service's current voice webhooks to the provider
- [`smallforce calls phone-numbers delete`](/docs/cli/commands/calls/phone-numbers/delete): Release the number with the provider and mark it deleted

## Complete command help

```text
Usage: smallforce calls phone-numbers [options] [command]

Search, purchase and manage inbound phone numbers

Options:
  --api-key <key>                          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>                      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                                   Print stable machine-readable JSON
  --text                                   Print human-readable text
  --format <format>                        Output format: text or json
  -h, --help                               display help for command

Commands:
  search [options]                         Search available phone numbers
  list [options]                           List purchased phone numbers and their billing status
  buy [options]                            Purchase a phone number; the service checks and charges
                                           credits
  get [options] <phoneNumberId>            Get a purchased phone number
  attach [options] <phoneNumberId>         Attach a purchased number to a voice assistant
  detach [options] <phoneNumberId>         Detach a number from its assistant; keep the purchased
                                           number
  sync-webhooks [options] <phoneNumberId>  Sync the service's current voice webhooks to the provider
  delete [options] <phoneNumberId>         Release the number with the provider and mark it deleted
  help [command]                           display help for command
```

## Related reference

- [`smallforce calls`](/docs/cli/commands/calls): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/calls/phone-numbers/search -->

# `smallforce calls phone-numbers search`

Search available phone numbers

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce calls phone-numbers search --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce calls phone-numbers search [options]

Search available phone numbers

Options:
  --api-key <key>        SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>    SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                 Print stable machine-readable JSON
  --text                 Print human-readable text
  --format <format>      Output format: text or json
  --country-code <code>  Two-letter country code
  --area-code <code>     Area code
  --contains <digits>    Digits to match
  --limit <number>       Maximum results (1-150)
  -h, --help             display help for command
```

## Related reference

- [`smallforce calls phone-numbers`](/docs/cli/commands/calls/phone-numbers): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/calls/phone-numbers/list -->

# `smallforce calls phone-numbers list`

List purchased phone numbers and their billing status

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce calls phone-numbers list --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce calls phone-numbers list [options]

List purchased phone numbers and their billing status

Options:
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  --include-deleted    Include released numbers
  -h, --help           display help for command
```

## Related reference

- [`smallforce calls phone-numbers`](/docs/cli/commands/calls/phone-numbers): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/calls/phone-numbers/buy -->

# `smallforce calls phone-numbers buy`

Purchase a phone number; the service checks and charges credits

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce calls phone-numbers buy --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce calls phone-numbers buy [options]

Purchase a phone number; the service checks and charges credits

Options:
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  --input <json>           Full settings as a JSON object; explicit flags take precedence
  --input-file <path>      Read settings JSON from a file, or - for stdin
  --phone-number <number>  E.164 phone number returned by search
  --purchase-id <uuid>     Purchase UUID; reuse it for every retry of this purchase
  --assistant-id <id>      Voice assistant to attach
  --friendly-name <name>   Display name
  --country-code <code>    Two-letter country code
  -h, --help               display help for command
```

## Related reference

- [`smallforce calls phone-numbers`](/docs/cli/commands/calls/phone-numbers): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/calls/phone-numbers/get -->

# `smallforce calls phone-numbers get`

Get a purchased phone number

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce calls phone-numbers get --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce calls phone-numbers get [options] <phoneNumberId>

Get a purchased phone number

Options:
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  --include-deleted    Include a released number
  -h, --help           display help for command
```

## Related reference

- [`smallforce calls phone-numbers`](/docs/cli/commands/calls/phone-numbers): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/calls/phone-numbers/attach -->

# `smallforce calls phone-numbers attach`

Attach a purchased number to a voice assistant

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce calls phone-numbers attach --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce calls phone-numbers attach [options] <phoneNumberId>

Attach a purchased number to a voice assistant

Options:
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  --assistant-id <id>  Voice assistant ID
  -h, --help           display help for command
```

## Related reference

- [`smallforce calls phone-numbers`](/docs/cli/commands/calls/phone-numbers): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/calls/phone-numbers/detach -->

# `smallforce calls phone-numbers detach`

Detach a number from its assistant; keep the purchased number

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce calls phone-numbers detach --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce calls phone-numbers detach [options] <phoneNumberId>

Detach a number from its assistant; keep the purchased number

Options:
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  -h, --help           display help for command
```

## Related reference

- [`smallforce calls phone-numbers`](/docs/cli/commands/calls/phone-numbers): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/calls/phone-numbers/sync-webhooks -->

# `smallforce calls phone-numbers sync-webhooks`

Sync the service's current voice webhooks to the provider

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce calls phone-numbers sync-webhooks --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce calls phone-numbers sync-webhooks [options] <phoneNumberId>

Sync the service's current voice webhooks to the provider

Options:
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  -h, --help           display help for command
```

## Related reference

- [`smallforce calls phone-numbers`](/docs/cli/commands/calls/phone-numbers): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/calls/phone-numbers/delete -->

# `smallforce calls phone-numbers delete`

Release the number with the provider and mark it deleted

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce calls phone-numbers delete --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce calls phone-numbers delete [options] <phoneNumberId>

Release the number with the provider and mark it deleted

Options:
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  -h, --help           display help for command
```

## Related reference

- [`smallforce calls phone-numbers`](/docs/cli/commands/calls/phone-numbers): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/calls/knowledge -->

# `smallforce calls knowledge`

Manage the existing voice knowledge and training jobs

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce calls knowledge --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce calls knowledge list`](/docs/cli/commands/calls/knowledge/list): List an assistant's knowledge and training status
- [`smallforce calls knowledge get`](/docs/cli/commands/calls/knowledge/get): Get knowledge content and current training status
- [`smallforce calls knowledge train-text`](/docs/cli/commands/calls/knowledge/train-text): Submit text to the existing training queue
- [`smallforce calls knowledge train-url`](/docs/cli/commands/calls/knowledge/train-url): Submit a URL to the existing training queue
- [`smallforce calls knowledge train-document`](/docs/cli/commands/calls/knowledge/train-document): Train an already uploaded document using its organization-owned storage key
- [`smallforce calls knowledge delete`](/docs/cli/commands/calls/knowledge/delete): Delete knowledge through the existing deletion service

## Complete command help

```text
Usage: smallforce calls knowledge [options] [command]

Manage the existing voice knowledge and training jobs

Options:
  --api-key <key>                 SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>             SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                          Print stable machine-readable JSON
  --text                          Print human-readable text
  --format <format>               Output format: text or json
  -h, --help                      display help for command

Commands:
  list [options]                  List an assistant's knowledge and training status
  get [options] <knowledgeId>     Get knowledge content and current training status
  train-text [options]            Submit text to the existing training queue
  train-url [options]             Submit a URL to the existing training queue
  train-document [options]        Train an already uploaded document using its organization-owned
                                  storage key
  delete [options] <knowledgeId>  Delete knowledge through the existing deletion service
  help [command]                  display help for command
```

## Related reference

- [`smallforce calls`](/docs/cli/commands/calls): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/calls/knowledge/list -->

# `smallforce calls knowledge list`

List an assistant's knowledge and training status

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce calls knowledge list --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce calls knowledge list [options]

List an assistant's knowledge and training status

Options:
  --api-key <key>         SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>     SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                  Print stable machine-readable JSON
  --text                  Print human-readable text
  --format <format>       Output format: text or json
  --assistant-id <id>     Voice assistant ID
  --include-deleted       Include deleted knowledge
  --limit <number>        Maximum results (1-500)
  --status <statuses...>  Filter training statuses (choices: "DRAFT", "PENDING", "IN_PROGRESS",
                          "EXTRACTED", "TRAINED", "FAILED", "DELETED", "DELETION_ERROR")
  --type <types...>       Filter knowledge types (choices: "TEXT", "URL", "PDF")
  -h, --help              display help for command
```

## Related reference

- [`smallforce calls knowledge`](/docs/cli/commands/calls/knowledge): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/calls/knowledge/get -->

# `smallforce calls knowledge get`

Get knowledge content and current training status

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce calls knowledge get --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce calls knowledge get [options] <knowledgeId>

Get knowledge content and current training status

Options:
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  --include-deleted    Include deleted knowledge
  -h, --help           display help for command
```

## Related reference

- [`smallforce calls knowledge`](/docs/cli/commands/calls/knowledge): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/calls/knowledge/train-text -->

# `smallforce calls knowledge train-text`

Submit text to the existing training queue

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce calls knowledge train-text --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce calls knowledge train-text [options]

Submit text to the existing training queue

Options:
  --api-key <key>        SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>    SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                 Print stable machine-readable JSON
  --text                 Print human-readable text
  --format <format>      Output format: text or json
  --input <json>         Full settings as a JSON object; explicit flags take precedence
  --input-file <path>    Read settings JSON from a file, or - for stdin
  --assistant-id <id>    Voice assistant ID
  --name <name>          Knowledge name
  --content <text>       Text to train
  --content-file <path>  Read text from a file, or - for stdin
  -h, --help             display help for command
```

## Related reference

- [`smallforce calls knowledge`](/docs/cli/commands/calls/knowledge): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/calls/knowledge/train-url -->

# `smallforce calls knowledge train-url`

Submit a URL to the existing training queue

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce calls knowledge train-url --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce calls knowledge train-url [options]

Submit a URL to the existing training queue

Options:
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  --input <json>       Full settings as a JSON object; explicit flags take precedence
  --input-file <path>  Read settings JSON from a file, or - for stdin
  --assistant-id <id>  Voice assistant ID
  --url <url>          URL to train
  --name <name>        Knowledge name
  -h, --help           display help for command
```

## Related reference

- [`smallforce calls knowledge`](/docs/cli/commands/calls/knowledge): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/calls/knowledge/train-document -->

# `smallforce calls knowledge train-document`

Train an already uploaded document using its organization-owned storage key

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce calls knowledge train-document --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce calls knowledge train-document [options]

Train an already uploaded document using its organization-owned storage key

Options:
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  --input <json>       Full settings as a JSON object; explicit flags take precedence
  --input-file <path>  Read settings JSON from a file, or - for stdin
  --assistant-id <id>  Voice assistant ID
  --name <name>        Knowledge name
  --storage-key <key>  Existing uploaded document storage key
  -h, --help           display help for command
```

## Related reference

- [`smallforce calls knowledge`](/docs/cli/commands/calls/knowledge): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/calls/knowledge/delete -->

# `smallforce calls knowledge delete`

Delete knowledge through the existing deletion service

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce calls knowledge delete --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce calls knowledge delete [options] <knowledgeId>

Delete knowledge through the existing deletion service

Options:
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  -h, --help           display help for command
```

## Related reference

- [`smallforce calls knowledge`](/docs/cli/commands/calls/knowledge): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/workspace -->

# `smallforce workspace`

Search, read, and write UTF-8 text in the organization's OS workspace

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce workspace --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce workspace search`](/docs/cli/commands/workspace/search): Run hybrid semantic and keyword search over indexed workspace files
- [`smallforce workspace get`](/docs/cli/commands/workspace/get): Read an indexed workspace text document
- [`smallforce workspace write`](/docs/cli/commands/workspace/write): Write one UTF-8 text file into the workspace

## Complete command help

```text
Usage: smallforce workspace [options] [command]

Search, read, and write UTF-8 text in the organization's OS workspace

Options:
  -h, --help                display help for command

Commands:
  search [options] <query>  Run hybrid semantic and keyword search over indexed workspace files
  get [options] <path>      Read an indexed workspace text document
  write [options] <path>    Write one UTF-8 text file into the workspace
  help [command]            display help for command
```

## Related reference

- [`smallforce`](/docs/cli/commands): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/workspace/search -->

# `smallforce workspace search`

Run hybrid semantic and keyword search over indexed workspace files

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce workspace search --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce workspace search [options] <query>

Run hybrid semantic and keyword search over indexed workspace files

Arguments:
  query                Question or search phrase

Options:
  --path <path>        Restrict search to a workspace-relative path
  --limit <count>      Matches to return, 1-20
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  -h, --help           display help for command
```

## Related reference

- [`smallforce workspace`](/docs/cli/commands/workspace): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/workspace/get -->

# `smallforce workspace get`

Read an indexed workspace text document

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce workspace get --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce workspace get [options] <path>

Read an indexed workspace text document

Arguments:
  path                   Workspace-relative path returned by search

Options:
  --offset <characters>  Character offset, starting at 0
  --max-chars <count>    Maximum characters to return, up to 1000000
  --api-key <key>        SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>    SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                 Print stable machine-readable JSON
  --text                 Print human-readable text
  --format <format>      Output format: text or json
  -h, --help             display help for command
```

## Related reference

- [`smallforce workspace`](/docs/cli/commands/workspace): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/workspace/write -->

# `smallforce workspace write`

Write one UTF-8 text file into the workspace

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce workspace write --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce workspace write [options] <path>

Write one UTF-8 text file into the workspace

Arguments:
  path                   POSIX workspace-relative destination path

Options:
  --content <text>       Inline UTF-8 text
  --content-file <path>  Read UTF-8 text from a local file, or - for stdin
  --overwrite            Replace the exact file when it already exists
  --api-key <key>        SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>    SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                 Print stable machine-readable JSON
  --text                 Print human-readable text
  --format <format>      Output format: text or json
  -h, --help             display help for command
```

## Related reference

- [`smallforce workspace`](/docs/cli/commands/workspace): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/app -->

# `smallforce app`

Initialize, deploy, inspect, and protect a generated application

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce app --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce app init`](/docs/cli/commands/app/init): Create a SmallForce application from a built-in or custom template
- [`smallforce app deploy`](/docs/cli/commands/app/deploy): Build an immutable release and activate Preview or the selected environment
- [`smallforce app status`](/docs/cli/commands/app/status): Read live application, environment, and release state
- [`smallforce app delete`](/docs/cli/commands/app/delete): Disable and remove an application from SmallForce
- [`smallforce app inspect`](/docs/cli/commands/app/inspect): Inspect the live app release, database, and files
- [`smallforce app db`](/docs/cli/commands/app/db): Inspect or query the application's implicit SQLite database
- [`smallforce app files`](/docs/cli/commands/app/files): Inspect files created or uploaded while the app is running
- [`smallforce app editor`](/docs/cli/commands/app/editor): Get the signed-in presentation editor URL; starts on first browser access
- [`smallforce app logs`](/docs/cli/commands/app/logs): Read application and runtime logs
- [`smallforce app events`](/docs/cli/commands/app/events): Read custom OpenTelemetry application events
- [`smallforce app analytics`](/docs/cli/commands/app/analytics): Read human visitor and crawler analytics
- [`smallforce app diagnostics`](/docs/cli/commands/app/diagnostics): Read request failures, rate limits, and runtime diagnostics
- [`smallforce app metrics`](/docs/cli/commands/app/metrics): Read request, latency, error, and response-size metrics
- [`smallforce app traces`](/docs/cli/commands/app/traces): List and inspect OpenTelemetry request traces
- [`smallforce app env`](/docs/cli/commands/app/env): Manage stable Preview, Production, and custom environment targets
- [`smallforce app var`](/docs/cli/commands/app/var): Manage plaintext variables for one explicit environment
- [`smallforce app secret`](/docs/cli/commands/app/secret): Manage write-only secrets for one explicit environment
- [`smallforce app release`](/docs/cli/commands/app/release): Inspect immutable application releases
- [`smallforce app security`](/docs/cli/commands/app/security): Read or replace optional application security controls
- [`smallforce app access`](/docs/cli/commands/app/access): Manage platform-level public, password, Google, or SSO access

## Complete command help

```text
Usage: smallforce app [options] [command]

Initialize, deploy, inspect, and protect a generated application

Options:
  -h, --help             display help for command

Commands:
  init [options]         Create a SmallForce application from a built-in or custom template
  deploy [options]       Build an immutable release and activate Preview or the selected environment
  status [options]       Read live application, environment, and release state
  delete [options]       Disable and remove an application from SmallForce
  inspect [options]      Inspect the live app release, database, and files
  db                     Inspect or query the application's implicit SQLite database
  files                  Inspect files created or uploaded while the app is running
  editor [options]       Get the signed-in presentation editor URL; starts on first browser access
  logs [options]         Read application and runtime logs
  events [options]       Read custom OpenTelemetry application events
  analytics [options]    Read human visitor and crawler analytics
  diagnostics [options]  Read request failures, rate limits, and runtime diagnostics
  metrics [options]      Read request, latency, error, and response-size metrics
  traces                 List and inspect OpenTelemetry request traces
  env                    Manage stable Preview, Production, and custom environment targets
  var                    Manage plaintext variables for one explicit environment
  secret                 Manage write-only secrets for one explicit environment
  release                Inspect immutable application releases
  security               Read or replace optional application security controls
  access                 Manage platform-level public, password, Google, or SSO access
  help [command]         display help for command
```

## Related reference

- [`smallforce`](/docs/cli/commands): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/app/init -->

# `smallforce app init`

Create a SmallForce application from a built-in or custom template

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce app init --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce app init [options]

Create a SmallForce application from a built-in or custom template

Options:
  --name <name>              Human-readable application name
  --slug <slug>              DNS-safe application slug
  --dir <path>               Project directory; defaults to the slug
  --template <template>      Built-in tanstack, astro, presentations, or worker template; also
                             accepts a Git URL or local directory
  --build-command <command>  Override the template build command
  --output <directory>       Override the template build output directory
  --entrypoint <path>        Override the Worker entrypoint relative to the build output
  --assets-directory <path>  Override the static assets directory relative to the build output
  --no-assets                Create an API-only Worker without static assets
  --package-manager <name>   Package manager for a custom template: bun, npm, or pnpm; built-ins use
                             Bun (default: "bun")
  --no-install               Do not install template dependencies
  --api-key <key>            SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>        SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                     Print stable machine-readable JSON
  --text                     Print human-readable text
  --format <format>          Output format: text or json
  -h, --help                 display help for command
```

## Related reference

- [`smallforce app`](/docs/cli/commands/app): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/app/deploy -->

# `smallforce app deploy`

Build an immutable release and activate Preview or the selected environment

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce app deploy --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce app deploy [options]

Build an immutable release and activate Preview or the selected environment

Options:
  --artifact <path>                  Existing ZIP; skips build and packaging
  --environment <name>               Activate this environment after the release is ready (default:
                                     "preview")
  --build-command <command>          Override smallforce.json build command
  --output <directory>               Override the configured output directory
  --name <name>                      Application name when adopting a project
  --slug <slug>                      Application slug when adopting a project
  --skip-build                       Package the existing output without rebuilding
  --timeout-seconds <seconds>        Terminal status timeout (default: "120")
  --poll-interval-ms <milliseconds>  Status poll interval (default: "500")
  --api-key <key>                    SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>                SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                             Print stable machine-readable JSON
  --text                             Print human-readable text
  --format <format>                  Output format: text or json
  -h, --help                         display help for command
```

## Related reference

- [`smallforce app`](/docs/cli/commands/app): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/app/status -->

# `smallforce app status`

Read live application, environment, and release state

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce app status --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce app status [options]

Read live application, environment, and release state

Options:
  --release-id <id>    Specific immutable release to inspect; defaults to the latest release
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  -h, --help           display help for command
```

## Related reference

- [`smallforce app`](/docs/cli/commands/app): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/app/delete -->

# `smallforce app delete`

Disable and remove an application from SmallForce

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce app delete --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce app delete [options]

Disable and remove an application from SmallForce

Options:
  --yes                Confirm permanent removal from the dashboard and public hostname
  --app-id <id>        Application id; defaults to smallforce.json in the current directory
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  -h, --help           display help for command
```

## Related reference

- [`smallforce app`](/docs/cli/commands/app): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/app/inspect -->

# `smallforce app inspect`

Inspect the live app release, database, and files

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce app inspect --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce app inspect [options]

Inspect the live app release, database, and files

Options:
  -e, --environment <name-or-id>  Environment name or UUID. Read commands default to preview;
                                  mutations require an explicit environment. (default: "preview")
  --app-id <id>                   Application id; defaults to smallforce.json in the current
                                  directory
  --api-key <key>                 SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>             SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                          Print stable machine-readable JSON
  --text                          Print human-readable text
  --format <format>               Output format: text or json
  -h, --help                      display help for command
```

## Related reference

- [`smallforce app`](/docs/cli/commands/app): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/app/db -->

# `smallforce app db`

Inspect or query the application's implicit SQLite database

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce app db --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce app db info`](/docs/cli/commands/app/db/info): Read SQLite usage and limit
- [`smallforce app db schema`](/docs/cli/commands/app/db/schema): List SQLite tables, indexes, views, and triggers
- [`smallforce app db query`](/docs/cli/commands/app/db/query): Execute parameterized SQLite against the selected application

## Complete command help

```text
Usage: smallforce app db [options] [command]

Inspect or query the application's implicit SQLite database

Options:
  -h, --help        display help for command

Commands:
  info [options]    Read SQLite usage and limit
  schema [options]  List SQLite tables, indexes, views, and triggers
  query [options]   Execute parameterized SQLite against the selected application
  help [command]    display help for command
```

## Related reference

- [`smallforce app`](/docs/cli/commands/app): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/app/db/info -->

# `smallforce app db info`

Read SQLite usage and limit

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce app db info --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce app db info [options]

Read SQLite usage and limit

Options:
  -e, --environment <name-or-id>  Environment name or UUID. Read commands default to preview;
                                  mutations require an explicit environment. (default: "preview")
  --app-id <id>                   Application id; defaults to smallforce.json in the current
                                  directory
  --api-key <key>                 SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>             SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                          Print stable machine-readable JSON
  --text                          Print human-readable text
  --format <format>               Output format: text or json
  -h, --help                      display help for command
```

## Related reference

- [`smallforce app db`](/docs/cli/commands/app/db): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/app/db/schema -->

# `smallforce app db schema`

List SQLite tables, indexes, views, and triggers

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce app db schema --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce app db schema [options]

List SQLite tables, indexes, views, and triggers

Options:
  -e, --environment <name-or-id>  Environment name or UUID. Read commands default to preview;
                                  mutations require an explicit environment. (default: "preview")
  --app-id <id>                   Application id; defaults to smallforce.json in the current
                                  directory
  --api-key <key>                 SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>             SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                          Print stable machine-readable JSON
  --text                          Print human-readable text
  --format <format>               Output format: text or json
  -h, --help                      display help for command
```

## Related reference

- [`smallforce app db`](/docs/cli/commands/app/db): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/app/db/query -->

# `smallforce app db query`

Execute parameterized SQLite against the selected application

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce app db query --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce app db query [options]

Execute parameterized SQLite against the selected application

Options:
  --sql <sql>                     SQL statement to execute
  --params-json <json>            JSON array of SQL parameters (default: "[]")
  -e, --environment <name-or-id>  Environment name or UUID. Read commands default to preview;
                                  mutations require an explicit environment.
  --app-id <id>                   Application id; defaults to smallforce.json in the current
                                  directory
  --api-key <key>                 SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>             SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                          Print stable machine-readable JSON
  --text                          Print human-readable text
  --format <format>               Output format: text or json
  -h, --help                      display help for command
```

## Related reference

- [`smallforce app db`](/docs/cli/commands/app/db): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/app/files -->

# `smallforce app files`

Inspect files created or uploaded while the app is running

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce app files --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce app files info`](/docs/cli/commands/app/files/info): Read actual file usage and limits
- [`smallforce app files list`](/docs/cli/commands/app/files/list): List application files
- [`smallforce app files get`](/docs/cli/commands/app/files/get): Inspect one application file
- [`smallforce app files download`](/docs/cli/commands/app/files/download): Download one application file

## Complete command help

```text
Usage: smallforce app files [options] [command]

Inspect files created or uploaded while the app is running

Options:
  -h, --help                 display help for command

Commands:
  info [options]             Read actual file usage and limits
  list [options]             List application files
  get [options] <path>       Inspect one application file
  download [options] <path>  Download one application file
  help [command]             display help for command
```

## Related reference

- [`smallforce app`](/docs/cli/commands/app): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/app/files/info -->

# `smallforce app files info`

Read actual file usage and limits

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce app files info --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce app files info [options]

Read actual file usage and limits

Options:
  -e, --environment <name-or-id>  Environment name or UUID. Read commands default to preview;
                                  mutations require an explicit environment. (default: "preview")
  --app-id <id>                   Application id; defaults to smallforce.json in the current
                                  directory
  --api-key <key>                 SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>             SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                          Print stable machine-readable JSON
  --text                          Print human-readable text
  --format <format>               Output format: text or json
  -h, --help                      display help for command
```

## Related reference

- [`smallforce app files`](/docs/cli/commands/app/files): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/app/files/list -->

# `smallforce app files list`

List application files

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce app files list --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce app files list [options]

List application files

Options:
  --prefix <prefix>               Limit results to this relative path prefix
  --cursor <cursor>               Opaque cursor returned by the previous page
  --limit <count>                 Objects per page (default: "100")
  -e, --environment <name-or-id>  Environment name or UUID. Read commands default to preview;
                                  mutations require an explicit environment. (default: "preview")
  --app-id <id>                   Application id; defaults to smallforce.json in the current
                                  directory
  --api-key <key>                 SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>             SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                          Print stable machine-readable JSON
  --text                          Print human-readable text
  --format <format>               Output format: text or json
  -h, --help                      display help for command
```

## Related reference

- [`smallforce app files`](/docs/cli/commands/app/files): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/app/files/get -->

# `smallforce app files get`

Inspect one application file

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce app files get --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce app files get [options] <path>

Inspect one application file

Options:
  --stdout                        Write the object bytes to standard output
  -e, --environment <name-or-id>  Environment name or UUID. Read commands default to preview;
                                  mutations require an explicit environment. (default: "preview")
  --app-id <id>                   Application id; defaults to smallforce.json in the current
                                  directory
  --api-key <key>                 SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>             SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                          Print stable machine-readable JSON
  --text                          Print human-readable text
  --format <format>               Output format: text or json
  -h, --help                      display help for command
```

## Related reference

- [`smallforce app files`](/docs/cli/commands/app/files): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/app/files/download -->

# `smallforce app files download`

Download one application file

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce app files download --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce app files download [options] <path>

Download one application file

Options:
  --output <path>                 Local destination path
  -e, --environment <name-or-id>  Environment name or UUID. Read commands default to preview;
                                  mutations require an explicit environment. (default: "preview")
  --app-id <id>                   Application id; defaults to smallforce.json in the current
                                  directory
  --api-key <key>                 SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>             SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                          Print stable machine-readable JSON
  --text                          Print human-readable text
  --format <format>               Output format: text or json
  -h, --help                      display help for command
```

## Related reference

- [`smallforce app files`](/docs/cli/commands/app/files): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/app/editor -->

# `smallforce app editor`

Get the signed-in presentation editor URL; starts on first browser access

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce app editor --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce app editor stop`](/docs/cli/commands/app/editor/stop): Stop this project's editor process; preserve its files

## Complete command help

```text
Usage: smallforce app editor [options] [command]

Get the signed-in presentation editor URL; starts on first browser access

Options:
  --deck <id>          Open a specific presentation deck
  --app-id <id>        Application id; defaults to smallforce.json in the current directory
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  -h, --help           display help for command

Commands:
  stop [options]       Stop this project's editor process; preserve its files
```

## Related reference

- [`smallforce app`](/docs/cli/commands/app): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/app/editor/stop -->

# `smallforce app editor stop`

Stop this project's editor process; preserve its files

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce app editor stop --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce app editor stop [options]

Stop this project's editor process; preserve its files

Options:
  --app-id <id>        Application id; defaults to smallforce.json in the current directory
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  -h, --help           display help for command
```

## Related reference

- [`smallforce app editor`](/docs/cli/commands/app/editor): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/app/logs -->

# `smallforce app logs`

Read application and runtime logs

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce app logs --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce app logs [options]

Read application and runtime logs

Options:
  --since <duration>              Look back from --to using a duration such as 30m, 6h, or 2d;
                                  defaults to 1h
  --from <timestamp>              Inclusive ISO-8601 start timestamp
  --to <timestamp>                Exclusive ISO-8601 end timestamp; defaults to now
  --minimum-level <level>         Minimum level: debug, info, warn, or error (default: "debug")
  --limit <count>                 Logs per page, from 1 to 200 (default: "100")
  --cursor <cursor>               Opaque cursor from the previous page
  -e, --environment <name-or-id>  Environment name or UUID. Read commands default to preview;
                                  mutations require an explicit environment. (default: "preview")
  --app-id <id>                   Application id; defaults to smallforce.json in the current
                                  directory
  --api-key <key>                 SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>             SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                          Print stable machine-readable JSON
  --text                          Print human-readable text
  --format <format>               Output format: text or json
  -h, --help                      display help for command
```

## Related reference

- [`smallforce app`](/docs/cli/commands/app): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/app/events -->

# `smallforce app events`

Read custom OpenTelemetry application events

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce app events --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce app events [options]

Read custom OpenTelemetry application events

Options:
  --since <duration>              Look back from --to using a duration such as 30m, 6h, or 2d;
                                  defaults to 1h
  --from <timestamp>              Inclusive ISO-8601 start timestamp
  --to <timestamp>                Exclusive ISO-8601 end timestamp; defaults to now
  --limit <count>                 Events per page, from 1 to 100 (default: "50")
  --cursor <cursor>               Opaque cursor from the previous page
  -e, --environment <name-or-id>  Environment name or UUID. Read commands default to preview;
                                  mutations require an explicit environment. (default: "preview")
  --app-id <id>                   Application id; defaults to smallforce.json in the current
                                  directory
  --api-key <key>                 SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>             SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                          Print stable machine-readable JSON
  --text                          Print human-readable text
  --format <format>               Output format: text or json
  -h, --help                      display help for command
```

## Related reference

- [`smallforce app`](/docs/cli/commands/app): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/app/analytics -->

# `smallforce app analytics`

Read human visitor and crawler analytics

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce app analytics --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce app analytics [options]

Read human visitor and crawler analytics

Options:
  --days <count>                  UTC days ending at --to; defaults to 30
  --from <date>                   Inclusive UTC start date in YYYY-MM-DD format
  --to <date>                     Inclusive UTC end date in YYYY-MM-DD format; defaults to today
  -e, --environment <name-or-id>  Environment name or UUID. Read commands default to preview;
                                  mutations require an explicit environment. (default: "preview")
  --app-id <id>                   Application id; defaults to smallforce.json in the current
                                  directory
  --api-key <key>                 SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>             SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                          Print stable machine-readable JSON
  --text                          Print human-readable text
  --format <format>               Output format: text or json
  -h, --help                      display help for command
```

## Related reference

- [`smallforce app`](/docs/cli/commands/app): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/app/diagnostics -->

# `smallforce app diagnostics`

Read request failures, rate limits, and runtime diagnostics

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce app diagnostics --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce app diagnostics [options]

Read request failures, rate limits, and runtime diagnostics

Options:
  --days <count>                  UTC days ending at --to; defaults to 7
  --from <date>                   Inclusive UTC start date in YYYY-MM-DD format
  --to <date>                     Inclusive UTC end date in YYYY-MM-DD format; defaults to today
  -e, --environment <name-or-id>  Environment name or UUID. Read commands default to preview;
                                  mutations require an explicit environment. (default: "preview")
  --app-id <id>                   Application id; defaults to smallforce.json in the current
                                  directory
  --api-key <key>                 SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>             SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                          Print stable machine-readable JSON
  --text                          Print human-readable text
  --format <format>               Output format: text or json
  -h, --help                      display help for command
```

## Related reference

- [`smallforce app`](/docs/cli/commands/app): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/app/metrics -->

# `smallforce app metrics`

Read request, latency, error, and response-size metrics

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce app metrics --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce app metrics [options]

Read request, latency, error, and response-size metrics

Options:
  --days <count>                  UTC days ending at --to; defaults to 7
  --from <date>                   Inclusive UTC start date in YYYY-MM-DD format
  --to <date>                     Inclusive UTC end date in YYYY-MM-DD format; defaults to today
  -e, --environment <name-or-id>  Environment name or UUID. Read commands default to preview;
                                  mutations require an explicit environment. (default: "preview")
  --app-id <id>                   Application id; defaults to smallforce.json in the current
                                  directory
  --api-key <key>                 SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>             SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                          Print stable machine-readable JSON
  --text                          Print human-readable text
  --format <format>               Output format: text or json
  -h, --help                      display help for command
```

## Related reference

- [`smallforce app`](/docs/cli/commands/app): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/app/traces -->

# `smallforce app traces`

List and inspect OpenTelemetry request traces

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce app traces --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce app traces list`](/docs/cli/commands/app/traces/list): List request traces
- [`smallforce app traces get`](/docs/cli/commands/app/traces/get): Inspect one trace and all of its spans

## Complete command help

```text
Usage: smallforce app traces [options] [command]

List and inspect OpenTelemetry request traces

Options:
  -h, --help               display help for command

Commands:
  list [options]           List request traces
  get [options] <traceId>  Inspect one trace and all of its spans
  help [command]           display help for command
```

## Related reference

- [`smallforce app`](/docs/cli/commands/app): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/app/traces/list -->

# `smallforce app traces list`

List request traces

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce app traces list --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce app traces list [options]

List request traces

Options:
  --since <duration>              Look back from --to using a duration such as 30m, 6h, or 2d;
                                  defaults to 1h
  --from <timestamp>              Inclusive ISO-8601 start timestamp
  --to <timestamp>                Exclusive ISO-8601 end timestamp; defaults to now
  --limit <count>                 Traces per page, from 1 to 100 (default: "50")
  --cursor <cursor>               Opaque cursor from the previous page
  -e, --environment <name-or-id>  Environment name or UUID. Read commands default to preview;
                                  mutations require an explicit environment. (default: "preview")
  --app-id <id>                   Application id; defaults to smallforce.json in the current
                                  directory
  --api-key <key>                 SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>             SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                          Print stable machine-readable JSON
  --text                          Print human-readable text
  --format <format>               Output format: text or json
  -h, --help                      display help for command
```

## Related reference

- [`smallforce app traces`](/docs/cli/commands/app/traces): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/app/traces/get -->

# `smallforce app traces get`

Inspect one trace and all of its spans

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce app traces get --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce app traces get [options] <traceId>

Inspect one trace and all of its spans

Options:
  -e, --environment <name-or-id>  Environment name or UUID. Read commands default to preview;
                                  mutations require an explicit environment. (default: "preview")
  --app-id <id>                   Application id; defaults to smallforce.json in the current
                                  directory
  --api-key <key>                 SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>             SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                          Print stable machine-readable JSON
  --text                          Print human-readable text
  --format <format>               Output format: text or json
  -h, --help                      display help for command
```

## Related reference

- [`smallforce app traces`](/docs/cli/commands/app/traces): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/app/env -->

# `smallforce app env`

Manage stable Preview, Production, and custom environment targets

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce app env --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce app env list`](/docs/cli/commands/app/env/list): List application environments
- [`smallforce app env create`](/docs/cli/commands/app/env/create): Create an isolated custom environment
- [`smallforce app env delete`](/docs/cli/commands/app/env/delete): Delete a custom environment and disable its route
- [`smallforce app env deploy`](/docs/cli/commands/app/env/deploy): Promote a ready immutable release to an environment
- [`smallforce app env config`](/docs/cli/commands/app/env/config): List variables and write-only secret names for one environment

## Complete command help

```text
Usage: smallforce app env [options] [command]

Manage stable Preview, Production, and custom environment targets

Options:
  -h, --help                     display help for command

Commands:
  list [options]                 List application environments
  create [options] <name>        Create an isolated custom environment
  delete [options] <name-or-id>  Delete a custom environment and disable its route
  deploy [options] <name-or-id>  Promote a ready immutable release to an environment
  config [options]               List variables and write-only secret names for one environment
  help [command]                 display help for command
```

## Related reference

- [`smallforce app`](/docs/cli/commands/app): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/app/env/list -->

# `smallforce app env list`

List application environments

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce app env list --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce app env list [options]

List application environments

Options:
  --app-id <id>        Application id; defaults to smallforce.json in the current directory
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  -h, --help           display help for command
```

## Related reference

- [`smallforce app env`](/docs/cli/commands/app/env): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/app/env/create -->

# `smallforce app env create`

Create an isolated custom environment

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce app env create --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce app env create [options] <name>

Create an isolated custom environment

Options:
  --app-id <id>        Application id; defaults to smallforce.json in the current directory
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  -h, --help           display help for command
```

## Related reference

- [`smallforce app env`](/docs/cli/commands/app/env): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/app/env/delete -->

# `smallforce app env delete`

Delete a custom environment and disable its route

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce app env delete --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce app env delete [options] <name-or-id>

Delete a custom environment and disable its route

Options:
  --yes                Confirm environment deletion
  --app-id <id>        Application id; defaults to smallforce.json in the current directory
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  -h, --help           display help for command
```

## Related reference

- [`smallforce app env`](/docs/cli/commands/app/env): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/app/env/deploy -->

# `smallforce app env deploy`

Promote a ready immutable release to an environment

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce app env deploy --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce app env deploy [options] <name-or-id>

Promote a ready immutable release to an environment

Options:
  --release <release-id>  Ready release UUID
  --app-id <id>           Application id; defaults to smallforce.json in the current directory
  --api-key <key>         SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>     SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                  Print stable machine-readable JSON
  --text                  Print human-readable text
  --format <format>       Output format: text or json
  -h, --help              display help for command
```

## Related reference

- [`smallforce app env`](/docs/cli/commands/app/env): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/app/env/config -->

# `smallforce app env config`

List variables and write-only secret names for one environment

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce app env config --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce app env config [options]

List variables and write-only secret names for one environment

Options:
  -e, --environment <name-or-id>  Environment name or UUID. Read commands default to preview;
                                  mutations require an explicit environment.
  --app-id <id>                   Application id; defaults to smallforce.json in the current
                                  directory
  --api-key <key>                 SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>             SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                          Print stable machine-readable JSON
  --text                          Print human-readable text
  --format <format>               Output format: text or json
  -h, --help                      display help for command
```

## Related reference

- [`smallforce app env`](/docs/cli/commands/app/env): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/app/var -->

# `smallforce app var`

Manage plaintext variables for one explicit environment

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce app var --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce app var set`](/docs/cli/commands/app/var/set): Create or replace a server-only variable
- [`smallforce app var delete`](/docs/cli/commands/app/var/delete): Delete a server-only variable

## Complete command help

```text
Usage: smallforce app var [options] [command]

Manage plaintext variables for one explicit environment

Options:
  -h, --help                    display help for command

Commands:
  set [options] <name> <value>  Create or replace a server-only variable
  delete [options] <name>       Delete a server-only variable
  help [command]                display help for command
```

## Related reference

- [`smallforce app`](/docs/cli/commands/app): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/app/var/set -->

# `smallforce app var set`

Create or replace a server-only variable

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce app var set --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce app var set [options] <name> <value>

Create or replace a server-only variable

Options:
  -e, --environment <name-or-id>  Environment name or UUID. Read commands default to preview;
                                  mutations require an explicit environment.
  --app-id <id>                   Application id; defaults to smallforce.json in the current
                                  directory
  --api-key <key>                 SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>             SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                          Print stable machine-readable JSON
  --text                          Print human-readable text
  --format <format>               Output format: text or json
  -h, --help                      display help for command
```

## Related reference

- [`smallforce app var`](/docs/cli/commands/app/var): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/app/var/delete -->

# `smallforce app var delete`

Delete a server-only variable

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce app var delete --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce app var delete [options] <name>

Delete a server-only variable

Options:
  -e, --environment <name-or-id>  Environment name or UUID. Read commands default to preview;
                                  mutations require an explicit environment.
  --app-id <id>                   Application id; defaults to smallforce.json in the current
                                  directory
  --api-key <key>                 SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>             SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                          Print stable machine-readable JSON
  --text                          Print human-readable text
  --format <format>               Output format: text or json
  -h, --help                      display help for command
```

## Related reference

- [`smallforce app var`](/docs/cli/commands/app/var): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/app/secret -->

# `smallforce app secret`

Manage write-only secrets for one explicit environment

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce app secret --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce app secret put`](/docs/cli/commands/app/secret/put): Create or replace a write-only secret
- [`smallforce app secret delete`](/docs/cli/commands/app/secret/delete): Delete a server secret

## Complete command help

```text
Usage: smallforce app secret [options] [command]

Manage write-only secrets for one explicit environment

Options:
  -h, --help               display help for command

Commands:
  put [options] <name>     Create or replace a write-only secret
  delete [options] <name>  Delete a server secret
  help [command]           display help for command
```

## Related reference

- [`smallforce app`](/docs/cli/commands/app): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/app/secret/put -->

# `smallforce app secret put`

Create or replace a write-only secret

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce app secret put --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce app secret put [options] <name>

Create or replace a write-only secret

Options:
  --value-file <path>             Read the secret from a file, or use - for stdin
  -e, --environment <name-or-id>  Environment name or UUID. Read commands default to preview;
                                  mutations require an explicit environment.
  --app-id <id>                   Application id; defaults to smallforce.json in the current
                                  directory
  --api-key <key>                 SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>             SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                          Print stable machine-readable JSON
  --text                          Print human-readable text
  --format <format>               Output format: text or json
  -h, --help                      display help for command
```

## Related reference

- [`smallforce app secret`](/docs/cli/commands/app/secret): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/app/secret/delete -->

# `smallforce app secret delete`

Delete a server secret

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce app secret delete --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce app secret delete [options] <name>

Delete a server secret

Options:
  -e, --environment <name-or-id>  Environment name or UUID. Read commands default to preview;
                                  mutations require an explicit environment.
  --app-id <id>                   Application id; defaults to smallforce.json in the current
                                  directory
  --api-key <key>                 SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>             SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                          Print stable machine-readable JSON
  --text                          Print human-readable text
  --format <format>               Output format: text or json
  -h, --help                      display help for command
```

## Related reference

- [`smallforce app secret`](/docs/cli/commands/app/secret): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/app/release -->

# `smallforce app release`

Inspect immutable application releases

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce app release --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce app release list`](/docs/cli/commands/app/release/list): List immutable releases and their active environments
- [`smallforce app release get`](/docs/cli/commands/app/release/get): Inspect one immutable release

## Complete command help

```text
Usage: smallforce app release [options] [command]

Inspect immutable application releases

Options:
  -h, --help                 display help for command

Commands:
  list [options]             List immutable releases and their active environments
  get [options] <releaseId>  Inspect one immutable release
  help [command]             display help for command
```

## Related reference

- [`smallforce app`](/docs/cli/commands/app): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/app/release/list -->

# `smallforce app release list`

List immutable releases and their active environments

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce app release list --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce app release list [options]

List immutable releases and their active environments

Options:
  --limit <count>      Maximum releases to return (default: "25")
  --app-id <id>        Application id; defaults to smallforce.json in the current directory
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  -h, --help           display help for command
```

## Related reference

- [`smallforce app release`](/docs/cli/commands/app/release): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/app/release/get -->

# `smallforce app release get`

Inspect one immutable release

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce app release get --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce app release get [options] <releaseId>

Inspect one immutable release

Options:
  --app-id <id>        Application id; defaults to smallforce.json in the current directory
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  -h, --help           display help for command
```

## Related reference

- [`smallforce app release`](/docs/cli/commands/app/release): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/app/security -->

# `smallforce app security`

Read or replace optional application security controls

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce app security --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce app security get`](/docs/cli/commands/app/security/get): Read the current policy and its machine-readable schema
- [`smallforce app security put`](/docs/cli/commands/app/security/put): Replace the complete policy; the backend validates it

## Complete command help

```text
Usage: smallforce app security [options] [command]

Read or replace optional application security controls

Options:
  -h, --help      display help for command

Commands:
  get [options]   Read the current policy and its machine-readable schema
  put [options]   Replace the complete policy; the backend validates it
  help [command]  display help for command
```

## Related reference

- [`smallforce app`](/docs/cli/commands/app): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/app/security/get -->

# `smallforce app security get`

Read the current policy and its machine-readable schema

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce app security get --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce app security get [options]

Read the current policy and its machine-readable schema

Options:
  --app-id <id>        Application id; defaults to smallforce.json in the current directory
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  -h, --help           display help for command
```

## Related reference

- [`smallforce app security`](/docs/cli/commands/app/security): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/app/security/put -->

# `smallforce app security put`

Replace the complete policy; the backend validates it

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce app security put --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce app security put [options]

Replace the complete policy; the backend validates it

Options:
  --file <path>        JSON policy file, or - to read JSON from stdin
  --app-id <id>        Application id; defaults to smallforce.json in the current directory
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  -h, --help           display help for command
```

## Related reference

- [`smallforce app security`](/docs/cli/commands/app/security): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/app/access -->

# `smallforce app access`

Manage platform-level public, password, Google, or SSO access

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce app access --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce app access get`](/docs/cli/commands/app/access/get): Read current access mode
- [`smallforce app access public`](/docs/cli/commands/app/access/public): Allow every visitor without a platform challenge
- [`smallforce app access password`](/docs/cli/commands/app/access/password): Require one shared password before serving the app
- [`smallforce app access google`](/docs/cli/commands/app/access/google): Allow only configured Google member emails
- [`smallforce app access sso`](/docs/cli/commands/app/access/sso): Require an active organization SSO connection
- [`smallforce app access members`](/docs/cli/commands/app/access/members): Manage the Google access allowlist

## Complete command help

```text
Usage: smallforce app access [options] [command]

Manage platform-level public, password, Google, or SSO access

Options:
  -h, --help                    display help for command

Commands:
  get [options]                 Read current access mode
  public [options]              Allow every visitor without a platform challenge
  password [options]            Require one shared password before serving the app
  google [options]              Allow only configured Google member emails
  sso [options] <connectionId>  Require an active organization SSO connection
  members                       Manage the Google access allowlist
  help [command]                display help for command
```

## Related reference

- [`smallforce app`](/docs/cli/commands/app): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/app/access/get -->

# `smallforce app access get`

Read current access mode

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce app access get --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce app access get [options]

Read current access mode

Options:
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  -h, --help           display help for command
```

## Related reference

- [`smallforce app access`](/docs/cli/commands/app/access): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/app/access/public -->

# `smallforce app access public`

Allow every visitor without a platform challenge

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce app access public --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce app access public [options]

Allow every visitor without a platform challenge

Options:
  --idempotency-key <key>  Retry-safe operation key
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce app access`](/docs/cli/commands/app/access): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/app/access/password -->

# `smallforce app access password`

Require one shared password before serving the app

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce app access password --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce app access password [options]

Require one shared password before serving the app

Options:
  --password <password>    Shared password; defaults to SMALLFORCE_SITE_PASSWORD
  --idempotency-key <key>  Retry-safe operation key
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce app access`](/docs/cli/commands/app/access): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/app/access/google -->

# `smallforce app access google`

Allow only configured Google member emails

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce app access google --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce app access google [options]

Allow only configured Google member emails

Options:
  --idempotency-key <key>  Retry-safe operation key
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce app access`](/docs/cli/commands/app/access): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/app/access/sso -->

# `smallforce app access sso`

Require an active organization SSO connection

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce app access sso --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce app access sso [options] <connectionId>

Require an active organization SSO connection

Options:
  --idempotency-key <key>  Retry-safe operation key
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce app access`](/docs/cli/commands/app/access): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/app/access/members -->

# `smallforce app access members`

Manage the Google access allowlist

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce app access members --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce app access members list`](/docs/cli/commands/app/access/members/list): List allowed emails
- [`smallforce app access members add`](/docs/cli/commands/app/access/members/add): Allow one Google account email
- [`smallforce app access members remove`](/docs/cli/commands/app/access/members/remove): Remove one Google member

## Complete command help

```text
Usage: smallforce app access members [options] [command]

Manage the Google access allowlist

Options:
  -h, --help                   display help for command

Commands:
  list [options]               List allowed emails
  add [options] <email>        Allow one Google account email
  remove [options] <memberId>  Remove one Google member
  help [command]               display help for command
```

## Related reference

- [`smallforce app access`](/docs/cli/commands/app/access): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/app/access/members/list -->

# `smallforce app access members list`

List allowed emails

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce app access members list --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce app access members list [options]

List allowed emails

Options:
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  -h, --help           display help for command
```

## Related reference

- [`smallforce app access members`](/docs/cli/commands/app/access/members): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/app/access/members/add -->

# `smallforce app access members add`

Allow one Google account email

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce app access members add --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce app access members add [options] <email>

Allow one Google account email

Options:
  --idempotency-key <key>  Retry-safe operation key
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce app access members`](/docs/cli/commands/app/access/members): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/app/access/members/remove -->

# `smallforce app access members remove`

Remove one Google member

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce app access members remove --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce app access members remove [options] <memberId>

Remove one Google member

Options:
  --idempotency-key <key>  Retry-safe operation key
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce app access members`](/docs/cli/commands/app/access/members): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/integrations -->

# `smallforce integrations`

Manage integration accounts, incoming events, and executable integration tools

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce integrations --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce integrations custom`](/docs/cli/commands/integrations/custom): Import and manage custom API integrations shared with the dashboard
- [`smallforce integrations connections`](/docs/cli/commands/integrations/connections): List, connect, and disconnect external app accounts
- [`smallforce integrations events`](/docs/cli/commands/integrations/events): Discover and configure connected-account events
- [`smallforce integrations tools`](/docs/cli/commands/integrations/tools): Search, inspect, and execute integration tools

## Complete command help

```text
Usage: smallforce integrations [options] [command]

Manage integration accounts, incoming events, and executable integration tools

Options:
  -h, --help      display help for command

Commands:
  custom          Import and manage custom API integrations shared with the dashboard
  connections     List, connect, and disconnect external app accounts
  events          Discover and configure connected-account events
  tools           Search, inspect, and execute integration tools
  help [command]  display help for command
```

## Related reference

- [`smallforce`](/docs/cli/commands): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/integrations/custom -->

# `smallforce integrations custom`

Import and manage custom API integrations shared with the dashboard

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce integrations custom --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce integrations custom list`](/docs/cli/commands/integrations/custom/list): List available custom API integrations
- [`smallforce integrations custom import`](/docs/cli/commands/integrations/custom/import): Import an OpenAPI document from a public HTTPS URL
- [`smallforce integrations custom get`](/docs/cli/commands/integrations/custom/get): Inspect setup, authentication configurations, connections, policies, and input schemas
- [`smallforce integrations custom operations`](/docs/cli/commands/integrations/custom/operations): Inspect operation keys, tool keys, schemas, auth requirements, and unsupported reasons
- [`smallforce integrations custom auth`](/docs/cli/commands/integrations/custom/auth): Configure how a custom API authenticates
- [`smallforce integrations custom connect`](/docs/cli/commands/integrations/custom/connect): Connect an account or start OAuth authorization for selected operations
- [`smallforce integrations custom policy`](/docs/cli/commands/integrations/custom/policy): Manage a connection's enabled API operations
- [`smallforce integrations custom reimport`](/docs/cli/commands/integrations/custom/reimport): Create a new spec snapshot; review operations and update connection policies separately

## Complete command help

```text
Usage: smallforce integrations custom [options] [command]

Import and manage custom API integrations shared with the dashboard

Options:
  -h, --help                            display help for command

Commands:
  list [options]                        List available custom API integrations
  import [options] <url>                Import an OpenAPI document from a public HTTPS URL
  get [options] <integrationId>         Inspect setup, authentication configurations, connections,
                                        policies, and input schemas
  operations [options] <integrationId>  Inspect operation keys, tool keys, schemas, auth
                                        requirements, and unsupported reasons
  auth                                  Configure how a custom API authenticates
  connect [options] <integrationId>     Connect an account or start OAuth authorization for selected
                                        operations
  policy                                Manage a connection's enabled API operations
  reimport [options] <integrationId>    Create a new spec snapshot; review operations and update
                                        connection policies separately
  help [command]                        display help for command
```

## Related reference

- [`smallforce integrations`](/docs/cli/commands/integrations): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/integrations/custom/list -->

# `smallforce integrations custom list`

List available custom API integrations

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce integrations custom list --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce integrations custom list [options]

List available custom API integrations

Options:
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  -h, --help           display help for command
```

## Related reference

- [`smallforce integrations custom`](/docs/cli/commands/integrations/custom): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/integrations/custom/import -->

# `smallforce integrations custom import`

Import an OpenAPI document from a public HTTPS URL

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce integrations custom import --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce integrations custom import [options] <url>

Import an OpenAPI document from a public HTTPS URL

Options:
  --slug <slug>                 Unique integration slug, for example inventory
  --spec-format <format>        Specification format; currently openapi (default: "openapi")
  --name <name>                 Display name; defaults to the spec title
  --description <text>          Description; defaults to the spec description
  --alias <names...>            Alternative names used in tool discovery
  --use-case <descriptions...>  Workflows used in tool discovery
  --api-key <key>               SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>           SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                        Print stable machine-readable JSON
  --text                        Print human-readable text
  --format <format>             Output format: text or json
  -h, --help                    display help for command
```

## Related reference

- [`smallforce integrations custom`](/docs/cli/commands/integrations/custom): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/integrations/custom/get -->

# `smallforce integrations custom get`

Inspect setup, authentication configurations, connections, policies, and input schemas

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce integrations custom get --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce integrations custom get [options] <integrationId>

Inspect setup, authentication configurations, connections, policies, and input schemas

Options:
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  -h, --help           display help for command
```

## Related reference

- [`smallforce integrations custom`](/docs/cli/commands/integrations/custom): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/integrations/custom/operations -->

# `smallforce integrations custom operations`

Inspect operation keys, tool keys, schemas, auth requirements, and unsupported reasons

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce integrations custom operations --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce integrations custom operations [options] <integrationId>

Inspect operation keys, tool keys, schemas, auth requirements, and unsupported reasons

Options:
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  -h, --help           display help for command
```

## Related reference

- [`smallforce integrations custom`](/docs/cli/commands/integrations/custom): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/integrations/custom/auth -->

# `smallforce integrations custom auth`

Configure how a custom API authenticates

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce integrations custom auth --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce integrations custom auth create`](/docs/cli/commands/integrations/custom/auth/create): Create an authentication configuration; reuse existing IDs from custom get

## Complete command help

```text
Usage: smallforce integrations custom auth [options] [command]

Configure how a custom API authenticates

Options:
  -h, --help                        display help for command

Commands:
  create [options] <integrationId>  Create an authentication configuration; reuse existing IDs from
                                    custom get
  help [command]                    display help for command
```

## Related reference

- [`smallforce integrations custom`](/docs/cli/commands/integrations/custom): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/integrations/custom/auth/create -->

# `smallforce integrations custom auth create`

Create an authentication configuration; reuse existing IDs from custom get

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce integrations custom auth create --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce integrations custom auth create [options] <integrationId>

Create an authentication configuration; reuse existing IDs from custom get

Options:
  --input-file <path>  Authentication configuration JSON file, or - for stdin
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  -h, --help           display help for command
```

## Related reference

- [`smallforce integrations custom auth`](/docs/cli/commands/integrations/custom/auth): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/integrations/custom/connect -->

# `smallforce integrations custom connect`

Connect an account or start OAuth authorization for selected operations

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce integrations custom connect --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce integrations custom connect [options] <integrationId>

Connect an account or start OAuth authorization for selected operations

Options:
  --input-file <path>  Connection configuration JSON file, or - for stdin
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  -h, --help           display help for command
```

## Related reference

- [`smallforce integrations custom`](/docs/cli/commands/integrations/custom): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/integrations/custom/policy -->

# `smallforce integrations custom policy`

Manage a connection's enabled API operations

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce integrations custom policy --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce integrations custom policy set`](/docs/cli/commands/integrations/custom/policy/set): Replace the allowed operations and approved base URL using the current spec snapshot

## Complete command help

```text
Usage: smallforce integrations custom policy [options] [command]

Manage a connection's enabled API operations

Options:
  -h, --help                    display help for command

Commands:
  set [options] <connectionId>  Replace the allowed operations and approved base URL using the
                                current spec snapshot
  help [command]                display help for command
```

## Related reference

- [`smallforce integrations custom`](/docs/cli/commands/integrations/custom): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/integrations/custom/policy/set -->

# `smallforce integrations custom policy set`

Replace the allowed operations and approved base URL using the current spec snapshot

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce integrations custom policy set --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce integrations custom policy set [options] <connectionId>

Replace the allowed operations and approved base URL using the current spec snapshot

Options:
  --input-file <path>  Policy JSON file with approvedBaseUrl and operationKeys, or - for stdin
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  -h, --help           display help for command
```

## Related reference

- [`smallforce integrations custom policy`](/docs/cli/commands/integrations/custom/policy): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/integrations/custom/reimport -->

# `smallforce integrations custom reimport`

Create a new spec snapshot; review operations and update connection policies separately

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce integrations custom reimport --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce integrations custom reimport [options] <integrationId>

Create a new spec snapshot; review operations and update connection policies separately

Options:
  --url <url>          Replacement public HTTPS spec URL; defaults to the saved source URL
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  -h, --help           display help for command
```

## Related reference

- [`smallforce integrations custom`](/docs/cli/commands/integrations/custom): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/integrations/connections -->

# `smallforce integrations connections`

List, connect, and disconnect external app accounts

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce integrations connections --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce integrations connections list`](/docs/cli/commands/integrations/connections/list): List connected and pending external app accounts
- [`smallforce integrations connections connect`](/docs/cli/commands/integrations/connections/connect): Start authorization for an external app account
- [`smallforce integrations connections disconnect`](/docs/cli/commands/integrations/connections/disconnect): Disconnect an external app account

## Complete command help

```text
Usage: smallforce integrations connections [options] [command]

List, connect, and disconnect external app accounts

Options:
  -h, --help                           display help for command

Commands:
  list [options]                       List connected and pending external app accounts
  connect [options] <toolkit>          Start authorization for an external app account
  disconnect [options] <connectionId>  Disconnect an external app account
  help [command]                       display help for command
```

## Related reference

- [`smallforce integrations`](/docs/cli/commands/integrations): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/integrations/connections/list -->

# `smallforce integrations connections list`

List connected and pending external app accounts

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce integrations connections list --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce integrations connections list [options]

List connected and pending external app accounts

Options:
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  -h, --help           display help for command
```

## Related reference

- [`smallforce integrations connections`](/docs/cli/commands/integrations/connections): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/integrations/connections/connect -->

# `smallforce integrations connections connect`

Start authorization for an external app account

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce integrations connections connect --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce integrations connections connect [options] <toolkit>

Start authorization for an external app account

Arguments:
  toolkit              Integration toolkit slug, for example gmail or slack

Options:
  --alias <name>       Human-readable label for this connected account
  --shop <domain>      Permanent Shopify domain, for example acme.myshopify.com
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  -h, --help           display help for command
```

## Related reference

- [`smallforce integrations connections`](/docs/cli/commands/integrations/connections): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/integrations/connections/disconnect -->

# `smallforce integrations connections disconnect`

Disconnect an external app account

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce integrations connections disconnect --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce integrations connections disconnect [options] <connectionId>

Disconnect an external app account

Arguments:
  connectionId         SmallForce connection id

Options:
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  -h, --help           display help for command
```

## Related reference

- [`smallforce integrations connections`](/docs/cli/commands/integrations/connections): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/integrations/events -->

# `smallforce integrations events`

Discover and configure connected-account events

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce integrations events --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce integrations events list`](/docs/cli/commands/integrations/events/list): List available events for one connected account
- [`smallforce integrations events get`](/docs/cli/commands/integrations/events/get): Get one event and its current rule, config, and payload shape
- [`smallforce integrations events enable`](/docs/cli/commands/integrations/events/enable): Enable incoming events for one connected account
- [`smallforce integrations events disable`](/docs/cli/commands/integrations/events/disable): Disable incoming events for one connected account
- [`smallforce integrations events configure`](/docs/cli/commands/integrations/events/configure): Create or update a rule for one connected-account event
- [`smallforce integrations events rules`](/docs/cli/commands/integrations/events/rules): Enable, disable, or delete existing event rules

## Complete command help

```text
Usage: smallforce integrations events [options] [command]

Discover and configure connected-account events

Options:
  -h, --help                       display help for command

Commands:
  list [options]                   List available events for one connected account
  get [options] <eventSlug>        Get one event and its current rule, config, and payload shape
  enable [options]                 Enable incoming events for one connected account
  disable [options]                Disable incoming events for one connected account
  configure [options] [eventSlug]  Create or update a rule for one connected-account event
  rules                            Enable, disable, or delete existing event rules
  help [command]                   display help for command
```

## Related reference

- [`smallforce integrations`](/docs/cli/commands/integrations): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/integrations/events/list -->

# `smallforce integrations events list`

List available events for one connected account

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce integrations events list --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce integrations events list [options]

List available events for one connected account

Options:
  --connection <id>    SmallForce connection id
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  -h, --help           display help for command
```

## Related reference

- [`smallforce integrations events`](/docs/cli/commands/integrations/events): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/integrations/events/get -->

# `smallforce integrations events get`

Get one event and its current rule, config, and payload shape

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce integrations events get --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce integrations events get [options] <eventSlug>

Get one event and its current rule, config, and payload shape

Arguments:
  eventSlug            Event slug returned by integrations events list

Options:
  --connection <id>    SmallForce connection id
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  -h, --help           display help for command
```

## Related reference

- [`smallforce integrations events`](/docs/cli/commands/integrations/events): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/integrations/events/enable -->

# `smallforce integrations events enable`

Enable incoming events for one connected account

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce integrations events enable --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce integrations events enable [options]

Enable incoming events for one connected account

Options:
  --connection <id>    SmallForce connection id
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  -h, --help           display help for command
```

## Related reference

- [`smallforce integrations events`](/docs/cli/commands/integrations/events): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/integrations/events/disable -->

# `smallforce integrations events disable`

Disable incoming events for one connected account

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce integrations events disable --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce integrations events disable [options]

Disable incoming events for one connected account

Options:
  --connection <id>    SmallForce connection id
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  -h, --help           display help for command
```

## Related reference

- [`smallforce integrations events`](/docs/cli/commands/integrations/events): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/integrations/events/configure -->

# `smallforce integrations events configure`

Create or update a rule for one connected-account event

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce integrations events configure --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce integrations events configure [options] [eventSlug]

Create or update a rule for one connected-account event

Arguments:
  eventSlug                   Event slug returned by integrations events list

Options:
  --event <slug>              Event slug, useful when omitting the argument
  --connection <id>           SmallForce connection id
  --profile <slug>            Target SmallForce profile slug
  --instructions <text>       Instructions for handling this event
  --instructions-file <path>  File containing event handling instructions, or - for stdin
  --chat <strategy>           Which chat events go to: connection (one per account), event (one per
                              subject), fixed, or new
  --target-chat <chatId>      Required when --chat fixed
  --include-payload           Include provider event payload in the rule
  --event-config <json>       Inline JSON object for event config
  --event-config-file <path>  JSON file containing event config, or - for stdin
  --api-key <key>             SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>         SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                      Print stable machine-readable JSON
  --text                      Print human-readable text
  --format <format>           Output format: text or json
  -h, --help                  display help for command
```

## Related reference

- [`smallforce integrations events`](/docs/cli/commands/integrations/events): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/integrations/events/rules -->

# `smallforce integrations events rules`

Enable, disable, or delete existing event rules

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce integrations events rules --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce integrations events rules enable`](/docs/cli/commands/integrations/events/rules/enable): Enable an existing event rule
- [`smallforce integrations events rules disable`](/docs/cli/commands/integrations/events/rules/disable): Disable an existing event rule
- [`smallforce integrations events rules delete`](/docs/cli/commands/integrations/events/rules/delete): Delete an event rule

## Complete command help

```text
Usage: smallforce integrations events rules [options] [command]

Enable, disable, or delete existing event rules

Options:
  -h, --help                  display help for command

Commands:
  enable [options] <ruleId>   Enable an existing event rule
  disable [options] <ruleId>  Disable an existing event rule
  delete [options] <ruleId>   Delete an event rule
  help [command]              display help for command
```

## Related reference

- [`smallforce integrations events`](/docs/cli/commands/integrations/events): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/integrations/events/rules/enable -->

# `smallforce integrations events rules enable`

Enable an existing event rule

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce integrations events rules enable --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce integrations events rules enable [options] <ruleId>

Enable an existing event rule

Arguments:
  ruleId               Event rule id

Options:
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  -h, --help           display help for command
```

## Related reference

- [`smallforce integrations events rules`](/docs/cli/commands/integrations/events/rules): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/integrations/events/rules/disable -->

# `smallforce integrations events rules disable`

Disable an existing event rule

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce integrations events rules disable --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce integrations events rules disable [options] <ruleId>

Disable an existing event rule

Arguments:
  ruleId               Event rule id

Options:
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  -h, --help           display help for command
```

## Related reference

- [`smallforce integrations events rules`](/docs/cli/commands/integrations/events/rules): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/integrations/events/rules/delete -->

# `smallforce integrations events rules delete`

Delete an event rule

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce integrations events rules delete --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce integrations events rules delete [options] <ruleId>

Delete an event rule

Arguments:
  ruleId               Event rule id

Options:
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  -h, --help           display help for command
```

## Related reference

- [`smallforce integrations events rules`](/docs/cli/commands/integrations/events/rules): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/integrations/tools -->

# `smallforce integrations tools`

Search, inspect, and execute integration tools

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce integrations tools --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce integrations tools search`](/docs/cli/commands/integrations/tools/search): Search integration tools by intent
- [`smallforce integrations tools get`](/docs/cli/commands/integrations/tools/get): Get one integration tool schema
- [`smallforce integrations tools execute`](/docs/cli/commands/integrations/tools/execute): Execute one integration tool with explicit JSON arguments

## Complete command help

```text
Usage: smallforce integrations tools [options] [command]

Search, inspect, and execute integration tools

Options:
  -h, --help                    display help for command

Commands:
  search [options] <query>      Search integration tools by intent
  get [options] <toolSlug>      Get one integration tool schema
  execute [options] <toolSlug>  Execute one integration tool with explicit JSON arguments
  help [command]                display help for command
```

## Related reference

- [`smallforce integrations`](/docs/cli/commands/integrations): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/integrations/tools/search -->

# `smallforce integrations tools search`

Search integration tools by intent

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce integrations tools search --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce integrations tools search [options] <query>

Search integration tools by intent

Arguments:
  query                Natural-language action, for example send an email

Options:
  --toolkit <slug>     Scope search to one toolkit, for example gmail
  --limit <n>          Number of tools to return, from 1 to 25
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  -h, --help           display help for command
```

## Related reference

- [`smallforce integrations tools`](/docs/cli/commands/integrations/tools): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/integrations/tools/get -->

# `smallforce integrations tools get`

Get one integration tool schema

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce integrations tools get --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce integrations tools get [options] <toolSlug>

Get one integration tool schema

Arguments:
  toolSlug             Tool slug returned by integrations tools search

Options:
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  -h, --help           display help for command
```

## Related reference

- [`smallforce integrations tools`](/docs/cli/commands/integrations/tools): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/integrations/tools/execute -->

# `smallforce integrations tools execute`

Execute one integration tool with explicit JSON arguments

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce integrations tools execute --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce integrations tools execute [options] <toolSlug>

Execute one integration tool with explicit JSON arguments

Arguments:
  toolSlug             Tool slug returned by integrations tools search

Options:
  --connection <id>    SmallForce connection id from integrations connections list or integrations
                       tools search
  --input <json>       Inline JSON object containing tool arguments
  --input-file <path>  JSON file containing tool arguments, or - for stdin
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  -h, --help           display help for command
```

## Related reference

- [`smallforce integrations tools`](/docs/cli/commands/integrations/tools): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/media -->

# `smallforce media`

Generate images, video, and audio with AI models

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce media --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce media models`](/docs/cli/commands/media/models): Discover media generation models
- [`smallforce media generate`](/docs/cli/commands/media/generate): Generate media with a model
- [`smallforce media jobs`](/docs/cli/commands/media/jobs): Track media generation jobs

## Complete command help

```text
Usage: smallforce media [options] [command]

Generate images, video, and audio with AI models

Options:
  -h, --help                       display help for command

Commands:
  models                           Discover media generation models
  generate [options] <endpointId>  Generate media with a model
  jobs                             Track media generation jobs
  help [command]                   display help for command
```

## Related reference

- [`smallforce`](/docs/cli/commands): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/media/models -->

# `smallforce media models`

Discover media generation models

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce media models --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce media models search`](/docs/cli/commands/media/models/search): Search media models by intent
- [`smallforce media models get`](/docs/cli/commands/media/models/get): Get one model's spec and input schema

## Complete command help

```text
Usage: smallforce media models [options] [command]

Discover media generation models

Options:
  -h, --help                  display help for command

Commands:
  search [options] <query>    Search media models by intent
  get [options] <endpointId>  Get one model's spec and input schema
  help [command]              display help for command
```

## Related reference

- [`smallforce media`](/docs/cli/commands/media): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/media/models/search -->

# `smallforce media models search`

Search media models by intent

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce media models search --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce media models search [options] <query>

Search media models by intent

Arguments:
  query                What you want to create, e.g. 'text to video'

Options:
  --limit <n>          Number of models to return, 1 to 25
  --category <slug>    Filter by category, e.g. text-to-image
  --modality <out>     Filter by output modality: image, video, audio
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  -h, --help           display help for command
```

## Related reference

- [`smallforce media models`](/docs/cli/commands/media/models): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/media/models/get -->

# `smallforce media models get`

Get one model's spec and input schema

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce media models get --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce media models get [options] <endpointId>

Get one model's spec and input schema

Arguments:
  endpointId           Endpoint id from media models search

Options:
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  -h, --help           display help for command
```

## Related reference

- [`smallforce media models`](/docs/cli/commands/media/models): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/media/generate -->

# `smallforce media generate`

Generate media with a model

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce media generate --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce media generate [options] <endpointId>

Generate media with a model

Arguments:
  endpointId               Endpoint id from media models search

Options:
  --input <json>           Model arguments as a JSON object
  --prompt <text>          Shortcut that sets input.prompt
  --image <assetId>        Use an asset as image_url (upload first with assets upload)
  --asset <field=assetId>  Map an asset to an input field (repeatable)
  --wait                   Wait for the job to finish, then print the result
  --out <path>             Download output(s) to this path (implies --wait)
  --timeout <s>            Max seconds to wait, default 300
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce media`](/docs/cli/commands/media): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/media/jobs -->

# `smallforce media jobs`

Track media generation jobs

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce media jobs --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce media jobs list`](/docs/cli/commands/media/jobs/list): List recent media jobs
- [`smallforce media jobs get`](/docs/cli/commands/media/jobs/get): Get a media job's status and outputs

## Complete command help

```text
Usage: smallforce media jobs [options] [command]

Track media generation jobs

Options:
  -h, --help             display help for command

Commands:
  list [options]         List recent media jobs
  get [options] <jobId>  Get a media job's status and outputs
  help [command]         display help for command
```

## Related reference

- [`smallforce media`](/docs/cli/commands/media): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/media/jobs/list -->

# `smallforce media jobs list`

List recent media jobs

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce media jobs list --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce media jobs list [options]

List recent media jobs

Options:
  --limit <n>          Number of jobs to return
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  -h, --help           display help for command
```

## Related reference

- [`smallforce media jobs`](/docs/cli/commands/media/jobs): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/media/jobs/get -->

# `smallforce media jobs get`

Get a media job's status and outputs

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce media jobs get --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce media jobs get [options] <jobId>

Get a media job's status and outputs

Arguments:
  jobId                Job id from media generate

Options:
  --wait               Wait for the job to finish
  --out <path>         Download output(s) to this path (implies --wait)
  --timeout <s>        Max seconds to wait, default 300
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  -h, --help           display help for command
```

## Related reference

- [`smallforce media jobs`](/docs/cli/commands/media/jobs): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/assets -->

# `smallforce assets`

Upload and manage organization-owned files used across SmallForce

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce assets --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce assets upload`](/docs/cli/commands/assets/upload): Upload a file and get an asset id
- [`smallforce assets get`](/docs/cli/commands/assets/get): Get an asset's metadata and a download URL
- [`smallforce assets delete`](/docs/cli/commands/assets/delete): Delete an asset

## Complete command help

```text
Usage: smallforce assets [options] [command]

Upload and manage organization-owned files used across SmallForce

Options:
  -h, --help                  display help for command

Commands:
  upload [options] <file>     Upload a file and get an asset id
  get [options] <assetId>     Get an asset's metadata and a download URL
  delete [options] <assetId>  Delete an asset
  help [command]              display help for command
```

## Related reference

- [`smallforce`](/docs/cli/commands): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/assets/upload -->

# `smallforce assets upload`

Upload a file and get an asset id

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce assets upload --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce assets upload [options] <file>

Upload a file and get an asset id

Arguments:
  file                 Path to the local file to upload

Options:
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  -h, --help           display help for command
```

## Related reference

- [`smallforce assets`](/docs/cli/commands/assets): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/assets/get -->

# `smallforce assets get`

Get an asset's metadata and a download URL

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce assets get --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce assets get [options] <assetId>

Get an asset's metadata and a download URL

Arguments:
  assetId              Asset id

Options:
  --out <path>         Download the asset to this path
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  -h, --help           display help for command
```

## Related reference

- [`smallforce assets`](/docs/cli/commands/assets): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/assets/delete -->

# `smallforce assets delete`

Delete an asset

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce assets delete --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce assets delete [options] <assetId>

Delete an asset

Arguments:
  assetId              Asset id

Options:
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  -h, --help           display help for command
```

## Related reference

- [`smallforce assets`](/docs/cli/commands/assets): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/social -->

# `smallforce social`

Connect social accounts, publish content, manage comments, inbox and reviews, and inspect analytics

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce social --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce social platforms`](/docs/cli/commands/social/platforms): Inspect supported platforms and platform-specific post options
- [`smallforce social profiles`](/docs/cli/commands/social/profiles): Create and list social provider profiles
- [`smallforce social accounts`](/docs/cli/commands/social/accounts): List, connect, and disconnect social accounts
- [`smallforce social posts`](/docs/cli/commands/social/posts): Validate, publish, inspect, update, cancel, and retry social posts
- [`smallforce social comments`](/docs/cli/commands/social/comments): List organic comment threads and manage public or private replies
- [`smallforce social inbox`](/docs/cli/commands/social/inbox): List conversations, inspect messages, mark conversations read, and send replies
- [`smallforce social reviews`](/docs/cli/commands/social/reviews): List Facebook and Google Business reviews and manage replies
- [`smallforce social sync`](/docs/cli/commands/social/sync): Refresh provider profiles, accounts, posts, and external posts into SmallForce
- [`smallforce social analytics`](/docs/cli/commands/social/analytics): Inspect cross-platform, post-level, and provider-specific social analytics

## Complete command help

```text
Usage: smallforce social [options] [command]

Connect social accounts, publish content, manage comments, inbox and reviews, and inspect analytics

Options:
  -h, --help      display help for command

Commands:
  platforms       Inspect supported platforms and platform-specific post options
  profiles        Create and list social provider profiles
  accounts        List, connect, and disconnect social accounts
  posts           Validate, publish, inspect, update, cancel, and retry social posts
  comments        List organic comment threads and manage public or private replies
  inbox           List conversations, inspect messages, mark conversations read, and send replies
  reviews         List Facebook and Google Business reviews and manage replies
  sync            Refresh provider profiles, accounts, posts, and external posts into SmallForce
  analytics       Inspect cross-platform, post-level, and provider-specific social analytics
  help [command]  display help for command
```

## Related reference

- [`smallforce`](/docs/cli/commands): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/social/platforms -->

# `smallforce social platforms`

Inspect supported platforms and platform-specific post options

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce social platforms --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce social platforms list`](/docs/cli/commands/social/platforms/list): List platform keys, capabilities, and publication option schemas

## Complete command help

```text
Usage: smallforce social platforms [options] [command]

Inspect supported platforms and platform-specific post options

Options:
  -h, --help      display help for command

Commands:
  list [options]  List platform keys, capabilities, and publication option schemas
  help [command]  display help for command
```

## Related reference

- [`smallforce social`](/docs/cli/commands/social): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/social/platforms/list -->

# `smallforce social platforms list`

List platform keys, capabilities, and publication option schemas

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce social platforms list --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce social platforms list [options]

List platform keys, capabilities, and publication option schemas

Options:
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  -h, --help           display help for command
```

## Related reference

- [`smallforce social platforms`](/docs/cli/commands/social/platforms): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/social/profiles -->

# `smallforce social profiles`

Create and list social provider profiles

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce social profiles --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce social profiles list`](/docs/cli/commands/social/profiles/list): List social profiles and the profile IDs used by account connect
- [`smallforce social profiles create`](/docs/cli/commands/social/profiles/create): Create a social profile used to group connected accounts

## Complete command help

```text
Usage: smallforce social profiles [options] [command]

Create and list social provider profiles

Options:
  -h, --help               display help for command

Commands:
  list [options]           List social profiles and the profile IDs used by account connect
  create [options] <name>  Create a social profile used to group connected accounts
  help [command]           display help for command
```

## Related reference

- [`smallforce social`](/docs/cli/commands/social): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/social/profiles/list -->

# `smallforce social profiles list`

List social profiles and the profile IDs used by account connect

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce social profiles list --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce social profiles list [options]

List social profiles and the profile IDs used by account connect

Options:
  --include-deleted    Include deleted profiles
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  -h, --help           display help for command
```

## Related reference

- [`smallforce social profiles`](/docs/cli/commands/social/profiles): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/social/profiles/create -->

# `smallforce social profiles create`

Create a social profile used to group connected accounts

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce social profiles create --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce social profiles create [options] <name>

Create a social profile used to group connected accounts

Arguments:
  name                  Profile name, for example Main brand

Options:
  --description <text>  Optional profile description
  --color <value>       Optional provider color value
  --api-key <key>       SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>   SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                Print stable machine-readable JSON
  --text                Print human-readable text
  --format <format>     Output format: text or json
  -h, --help            display help for command
```

## Related reference

- [`smallforce social profiles`](/docs/cli/commands/social/profiles): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/social/accounts -->

# `smallforce social accounts`

List, connect, and disconnect social accounts

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce social accounts --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce social accounts list`](/docs/cli/commands/social/accounts/list): List organization-owned social account IDs used by posts, inbox, reviews, and analytics
- [`smallforce social accounts connect`](/docs/cli/commands/social/accounts/connect): Create a provider authorization URL for a social platform
- [`smallforce social accounts disconnect`](/docs/cli/commands/social/accounts/disconnect): Disconnect one organization-owned social account

## Complete command help

```text
Usage: smallforce social accounts [options] [command]

List, connect, and disconnect social accounts

Options:
  -h, --help                        display help for command

Commands:
  list [options]                    List organization-owned social account IDs used by posts, inbox,
                                    reviews, and analytics
  connect [options] <platform>      Create a provider authorization URL for a social platform
  disconnect [options] <accountId>  Disconnect one organization-owned social account
  help [command]                    display help for command
```

## Related reference

- [`smallforce social`](/docs/cli/commands/social): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/social/accounts/list -->

# `smallforce social accounts list`

List organization-owned social account IDs used by posts, inbox, reviews, and analytics

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce social accounts list --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce social accounts list [options]

List organization-owned social account IDs used by posts, inbox, reviews, and analytics

Options:
  --profile <profileId>  Filter by profile id
  --platform <platform>  Filter by platform key
  --kind <kind>          Account kind: posting or ads
  --include-deleted      Include disconnected or deleted accounts
  --api-key <key>        SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>    SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                 Print stable machine-readable JSON
  --text                 Print human-readable text
  --format <format>      Output format: text or json
  -h, --help             display help for command
```

## Related reference

- [`smallforce social accounts`](/docs/cli/commands/social/accounts): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/social/accounts/connect -->

# `smallforce social accounts connect`

Create a provider authorization URL for a social platform

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce social accounts connect --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce social accounts connect [options] <platform>

Create a provider authorization URL for a social platform

Arguments:
  platform               Platform key from social platforms list

Options:
  --profile <profileId>  Profile id from social profiles list
  --redirect-url <url>   Browser destination after authorization
  --headless             Request a headless provider authorization flow
  --api-key <key>        SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>    SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                 Print stable machine-readable JSON
  --text                 Print human-readable text
  --format <format>      Output format: text or json
  -h, --help             display help for command
```

## Related reference

- [`smallforce social accounts`](/docs/cli/commands/social/accounts): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/social/accounts/disconnect -->

# `smallforce social accounts disconnect`

Disconnect one organization-owned social account

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce social accounts disconnect --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce social accounts disconnect [options] <accountId>

Disconnect one organization-owned social account

Arguments:
  accountId            Account id from social accounts list

Options:
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  -h, --help           display help for command
```

## Related reference

- [`smallforce social accounts`](/docs/cli/commands/social/accounts): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/social/posts -->

# `smallforce social posts`

Validate, publish, inspect, update, cancel, and retry social posts

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce social posts --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce social posts list`](/docs/cli/commands/social/posts/list): List social posts and post IDs
- [`smallforce social posts get`](/docs/cli/commands/social/posts/get): Get one social post, publication statuses, errors, and URLs
- [`smallforce social posts create`](/docs/cli/commands/social/posts/create): Create a draft, publish now, or schedule a social post
- [`smallforce social posts validate`](/docs/cli/commands/social/posts/validate): Validate post content, media, publications, and platformOptions without creating a post
- [`smallforce social posts update`](/docs/cli/commands/social/posts/update): Update an editable draft, scheduled, failed, partial, or cancelled post
- [`smallforce social posts delete`](/docs/cli/commands/social/posts/delete): Delete a draft or cancel a scheduled post
- [`smallforce social posts retry`](/docs/cli/commands/social/posts/retry): Retry a failed or partially published social post

## Complete command help

```text
Usage: smallforce social posts [options] [command]

Validate, publish, inspect, update, cancel, and retry social posts

Options:
  -h, --help                 display help for command

Commands:
  list [options]             List social posts and post IDs
  get [options] <postId>     Get one social post, publication statuses, errors, and URLs
  create [options]           Create a draft, publish now, or schedule a social post
  validate [options]         Validate post content, media, publications, and platformOptions without
                             creating a post
  update [options] <postId>  Update an editable draft, scheduled, failed, partial, or cancelled post
  delete [options] <postId>  Delete a draft or cancel a scheduled post
  retry [options] <postId>   Retry a failed or partially published social post
  help [command]             display help for command
```

## Related reference

- [`smallforce social`](/docs/cli/commands/social): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/social/posts/list -->

# `smallforce social posts list`

List social posts and post IDs

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce social posts list --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce social posts list [options]

List social posts and post IDs

Options:
  --profile <profileId>  Filter by social profile id
  --status <status>      Filter by post status
  --limit <n>            Page size from 1 to 250
  --cursor <cursor>      Opaque cursor returned by the previous page
  --include-deleted      Include deleted or cancelled posts
  --api-key <key>        SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>    SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                 Print stable machine-readable JSON
  --text                 Print human-readable text
  --format <format>      Output format: text or json
  -h, --help             display help for command
```

## Related reference

- [`smallforce social posts`](/docs/cli/commands/social/posts): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/social/posts/get -->

# `smallforce social posts get`

Get one social post, publication statuses, errors, and URLs

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce social posts get --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce social posts get [options] <postId>

Get one social post, publication statuses, errors, and URLs

Arguments:
  postId               Post id from social posts list or create

Options:
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  -h, --help           display help for command
```

## Related reference

- [`smallforce social posts`](/docs/cli/commands/social/posts): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/social/posts/create -->

# `smallforce social posts create`

Create a draft, publish now, or schedule a social post

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce social posts create --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce social posts create [options]

Create a draft, publish now, or schedule a social post

Options:
  --content <text>         Shared post text
  --title <text>           Internal post title
  --profile <profileId>    Social profile id from social profiles list
  --scheduled-for <iso>    ISO timestamp required for schedule mode
  --timezone <iana>        IANA timezone, for example America/Detroit
  --asset <assetId>        SmallForce asset id; repeat for multiple media (default: [])
  --media-url <url>        Public media URL; repeat for multiple media (default: [])
  --hashtag <tag>          Hashtag without transport-specific formatting; repeatable (default: [])
  --tag <tag>              Internal post tag; repeatable (default: [])
  --publication <json>     Publication object; repeat once per target account (default: [])
  --metadata <json>        Inline JSON object stored with the post
  --publish <mode>         Publish mode: draft, now, or schedule (default: "draft")
  --idempotency-key <key>  Stable key preventing duplicate creates
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce social posts`](/docs/cli/commands/social/posts): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/social/posts/validate -->

# `smallforce social posts validate`

Validate post content, media, publications, and platformOptions without creating a post

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce social posts validate --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce social posts validate [options]

Validate post content, media, publications, and platformOptions without creating a post

Options:
  --content <text>         Shared post text
  --title <text>           Internal post title
  --profile <profileId>    Social profile id from social profiles list
  --scheduled-for <iso>    ISO timestamp required for schedule mode
  --timezone <iana>        IANA timezone, for example America/Detroit
  --asset <assetId>        SmallForce asset id; repeat for multiple media (default: [])
  --media-url <url>        Public media URL; repeat for multiple media (default: [])
  --hashtag <tag>          Hashtag without transport-specific formatting; repeatable (default: [])
  --tag <tag>              Internal post tag; repeatable (default: [])
  --publication <json>     Publication object; repeat once per target account (default: [])
  --metadata <json>        Inline JSON object stored with the post
  --publish <mode>         Publish mode: draft, now, or schedule (default: "draft")
  --idempotency-key <key>  Stable key preventing duplicate creates
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce social posts`](/docs/cli/commands/social/posts): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/social/posts/update -->

# `smallforce social posts update`

Update an editable draft, scheduled, failed, partial, or cancelled post

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce social posts update --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce social posts update [options] <postId>

Update an editable draft, scheduled, failed, partial, or cancelled post

Arguments:
  postId                       Post id from social posts list

Options:
  --content <text>             Shared post text
  --title <text>               Internal post title
  --profile <profileId>        Social profile id from social profiles list
  --scheduled-for <iso>        ISO timestamp required for schedule mode
  --timezone <iana>            IANA timezone, for example America/Detroit
  --asset <assetId>            SmallForce asset id; repeat for multiple media (default: [])
  --media-url <url>            Public media URL; repeat for multiple media (default: [])
  --hashtag <tag>              Hashtag without transport-specific formatting; repeatable (default:
                               [])
  --tag <tag>                  Internal post tag; repeatable (default: [])
  --publication <json>         Publication object; repeat once per target account (default: [])
  --metadata <json>            Inline JSON object stored with the post
  --publish <mode>             Publish mode: draft, now, or schedule
  --mention <value>            Mention value; repeatable (default: [])
  --visibility <value>         private, public, or unlisted
  --crossposting <true|false>  Enable or disable crossposting
  --recycling <json>           Inline JSON recycling configuration
  --api-key <key>              SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>          SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                       Print stable machine-readable JSON
  --text                       Print human-readable text
  --format <format>            Output format: text or json
  -h, --help                   display help for command
```

## Related reference

- [`smallforce social posts`](/docs/cli/commands/social/posts): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/social/posts/delete -->

# `smallforce social posts delete`

Delete a draft or cancel a scheduled post

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce social posts delete --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce social posts delete [options] <postId>

Delete a draft or cancel a scheduled post

Arguments:
  postId               Post id from social posts list

Options:
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  -h, --help           display help for command
```

## Related reference

- [`smallforce social posts`](/docs/cli/commands/social/posts): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/social/posts/retry -->

# `smallforce social posts retry`

Retry a failed or partially published social post

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce social posts retry --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce social posts retry [options] <postId>

Retry a failed or partially published social post

Arguments:
  postId               Failed or partial post id from social posts list

Options:
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  -h, --help           display help for command
```

## Related reference

- [`smallforce social posts`](/docs/cli/commands/social/posts): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/social/comments -->

# `smallforce social comments`

List organic comment threads and manage public or private replies

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce social comments --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce social comments threads`](/docs/cli/commands/social/comments/threads): List posts with organic comments
- [`smallforce social comments list`](/docs/cli/commands/social/comments/list): Refresh and list comments in one local thread
- [`smallforce social comments reply`](/docs/cli/commands/social/comments/reply): Publish a top-level comment or reply to a specific comment
- [`smallforce social comments edit`](/docs/cli/commands/social/comments/edit): Edit a Reddit comment
- [`smallforce social comments delete`](/docs/cli/commands/social/comments/delete): Delete a provider comment
- [`smallforce social comments hide`](/docs/cli/commands/social/comments/hide): Hide a supported provider comment
- [`smallforce social comments unhide`](/docs/cli/commands/social/comments/unhide): Unhide a supported provider comment
- [`smallforce social comments unlike`](/docs/cli/commands/social/comments/unlike): Remove the connected account's like
- [`smallforce social comments like`](/docs/cli/commands/social/comments/like): Like or react to a supported provider comment
- [`smallforce social comments moderate`](/docs/cli/commands/social/comments/moderate): Set YouTube comment moderation status
- [`smallforce social comments private-reply`](/docs/cli/commands/social/comments/private-reply): Send a Facebook or Instagram private reply to a comment

## Complete command help

```text
Usage: smallforce social comments [options] [command]

List organic comment threads and manage public or private replies

Options:
  -h, --help                           display help for command

Commands:
  threads                              List posts with organic comments
  list [options] <threadId>            Refresh and list comments in one local thread
  reply [options] <threadId>           Publish a top-level comment or reply to a specific comment
  edit [options] <commentId>           Edit a Reddit comment
  delete [options] <commentId>         Delete a provider comment
  hide [options] <commentId>           Hide a supported provider comment
  unhide [options] <commentId>         Unhide a supported provider comment
  unlike [options] <commentId>         Remove the connected account's like
  like [options] <commentId>           Like or react to a supported provider comment
  moderate [options] <commentId>       Set YouTube comment moderation status
  private-reply [options] <commentId>  Send a Facebook or Instagram private reply to a comment
  help [command]                       display help for command
```

## Related reference

- [`smallforce social`](/docs/cli/commands/social): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/social/comments/threads -->

# `smallforce social comments threads`

List posts with organic comments

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce social comments threads --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce social comments threads list`](/docs/cli/commands/social/comments/threads/list): Refresh and list organization-owned organic comment threads

## Complete command help

```text
Usage: smallforce social comments threads [options] [command]

List posts with organic comments

Options:
  -h, --help      display help for command

Commands:
  list [options]  Refresh and list organization-owned organic comment threads
  help [command]  display help for command
```

## Related reference

- [`smallforce social comments`](/docs/cli/commands/social/comments): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/social/comments/threads/list -->

# `smallforce social comments threads list`

Refresh and list organization-owned organic comment threads

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce social comments threads list --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce social comments threads list [options]

Refresh and list organization-owned organic comment threads

Options:
  --account <accountId>  Account id from social accounts list
  --profile <profileId>  Profile id from social profiles list
  --platform <platform>  Organic social platform key
  --sort <field>         date or comments
  --order <order>        asc or desc
  --limit <n>            Page size from 1 to 100
  --cursor <cursor>      Opaque cursor from the previous page
  --include-deleted      Include locally deleted threads
  --api-key <key>        SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>    SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                 Print stable machine-readable JSON
  --text                 Print human-readable text
  --format <format>      Output format: text or json
  -h, --help             display help for command
```

## Related reference

- [`smallforce social comments threads`](/docs/cli/commands/social/comments/threads): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/social/comments/list -->

# `smallforce social comments list`

Refresh and list comments in one local thread

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce social comments list --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce social comments list [options] <threadId>

Refresh and list comments in one local thread

Arguments:
  threadId              Thread id from social comments threads list

Options:
  --parent <commentId>  Page replies to a local Facebook, Instagram, or Reddit comment
  --limit <n>           Page size from 1 to 100
  --cursor <cursor>     Opaque provider cursor from the previous page
  --api-key <key>       SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>   SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                Print stable machine-readable JSON
  --text                Print human-readable text
  --format <format>     Output format: text or json
  -h, --help            display help for command
```

## Related reference

- [`smallforce social comments`](/docs/cli/commands/social/comments): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/social/comments/reply -->

# `smallforce social comments reply`

Publish a top-level comment or reply to a specific comment

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce social comments reply --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce social comments reply [options] <threadId>

Publish a top-level comment or reply to a specific comment

Arguments:
  threadId                Thread id from social comments threads list

Options:
  --message <text>        Public reply text
  --parent <commentId>    Comment id from social comments list
  --attachment-url <url>  Public Facebook image URL
  --api-key <key>         SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>     SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                  Print stable machine-readable JSON
  --text                  Print human-readable text
  --format <format>       Output format: text or json
  -h, --help              display help for command
```

## Related reference

- [`smallforce social comments`](/docs/cli/commands/social/comments): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/social/comments/edit -->

# `smallforce social comments edit`

Edit a Reddit comment

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce social comments edit --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce social comments edit [options] <commentId>

Edit a Reddit comment

Arguments:
  commentId            Comment id from social comments list

Options:
  --message <text>     Replacement comment text
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  -h, --help           display help for command
```

## Related reference

- [`smallforce social comments`](/docs/cli/commands/social/comments): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/social/comments/delete -->

# `smallforce social comments delete`

Delete a provider comment

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce social comments delete --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce social comments delete [options] <commentId>

Delete a provider comment

Arguments:
  commentId            Comment id from social comments list

Options:
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  -h, --help           display help for command
```

## Related reference

- [`smallforce social comments`](/docs/cli/commands/social/comments): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/social/comments/hide -->

# `smallforce social comments hide`

Hide a supported provider comment

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce social comments hide --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce social comments hide [options] <commentId>

Hide a supported provider comment

Arguments:
  commentId            Comment id from social comments list

Options:
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  -h, --help           display help for command
```

## Related reference

- [`smallforce social comments`](/docs/cli/commands/social/comments): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/social/comments/unhide -->

# `smallforce social comments unhide`

Unhide a supported provider comment

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce social comments unhide --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce social comments unhide [options] <commentId>

Unhide a supported provider comment

Arguments:
  commentId            Comment id from social comments list

Options:
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  -h, --help           display help for command
```

## Related reference

- [`smallforce social comments`](/docs/cli/commands/social/comments): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/social/comments/unlike -->

# `smallforce social comments unlike`

Remove the connected account's like

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce social comments unlike --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce social comments unlike [options] <commentId>

Remove the connected account's like

Arguments:
  commentId            Comment id from social comments list

Options:
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  -h, --help           display help for command
```

## Related reference

- [`smallforce social comments`](/docs/cli/commands/social/comments): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/social/comments/like -->

# `smallforce social comments like`

Like or react to a supported provider comment

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce social comments like --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce social comments like [options] <commentId>

Like or react to a supported provider comment

Arguments:
  commentId            Comment id from social comments list

Options:
  --reaction <type>    LinkedIn reaction: LIKE, PRAISE, EMPATHY, INTEREST, APPRECIATION, or
                       ENTERTAINMENT
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  -h, --help           display help for command
```

## Related reference

- [`smallforce social comments`](/docs/cli/commands/social/comments): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/social/comments/moderate -->

# `smallforce social comments moderate`

Set YouTube comment moderation status

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce social comments moderate --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce social comments moderate [options] <commentId>

Set YouTube comment moderation status

Arguments:
  commentId            Comment id from social comments list

Options:
  --status <status>    published, rejected, or heldForReview
  --ban-author         Ban the author; valid only with rejected
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  -h, --help           display help for command
```

## Related reference

- [`smallforce social comments`](/docs/cli/commands/social/comments): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/social/comments/private-reply -->

# `smallforce social comments private-reply`

Send a Facebook or Instagram private reply to a comment

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce social comments private-reply --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce social comments private-reply [options] <commentId>

Send a Facebook or Instagram private reply to a comment

Arguments:
  commentId             Comment id from social comments list

Options:
  --message <text>      Private message text
  --quick-reply <json>  Quick-reply object; repeatable and mutually exclusive with --button
                        (default: [])
  --button <json>       URL, postback, or phone button object; repeatable (default: [])
  --api-key <key>       SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>   SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                Print stable machine-readable JSON
  --text                Print human-readable text
  --format <format>     Output format: text or json
  -h, --help            display help for command
```

## Related reference

- [`smallforce social comments`](/docs/cli/commands/social/comments): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/social/inbox -->

# `smallforce social inbox`

List conversations, inspect messages, mark conversations read, and send replies

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce social inbox --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce social inbox analytics`](/docs/cli/commands/social/inbox/analytics): Inspect inbox volume, activity timing, sources, response time, accounts, and conversations
- [`smallforce social inbox conversations`](/docs/cli/commands/social/inbox/conversations): List and manage inbox conversations
- [`smallforce social inbox messages`](/docs/cli/commands/social/inbox/messages): List and send messages inside a conversation

## Complete command help

```text
Usage: smallforce social inbox [options] [command]

List conversations, inspect messages, mark conversations read, and send replies

Options:
  -h, --help      display help for command

Commands:
  analytics       Inspect inbox volume, activity timing, sources, response time, accounts, and
                  conversations
  conversations   List and manage inbox conversations
  messages        List and send messages inside a conversation
  help [command]  display help for command
```

## Related reference

- [`smallforce social`](/docs/cli/commands/social): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/social/inbox/analytics -->

# `smallforce social inbox analytics`

Inspect inbox volume, activity timing, sources, response time, accounts, and conversations

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce social inbox analytics --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce social inbox analytics volume`](/docs/cli/commands/social/inbox/analytics/volume): Show sent and received volume
- [`smallforce social inbox analytics heatmap`](/docs/cli/commands/social/inbox/analytics/heatmap): Show inbox activity by weekday and hour
- [`smallforce social inbox analytics sources`](/docs/cli/commands/social/inbox/analytics/sources): Break inbox activity down by message source
- [`smallforce social inbox analytics response-time`](/docs/cli/commands/social/inbox/analytics/response-time): Show inbox response-time percentiles and histogram
- [`smallforce social inbox analytics top-accounts`](/docs/cli/commands/social/inbox/analytics/top-accounts): Rank inbox accounts by message activity
- [`smallforce social inbox analytics conversations`](/docs/cli/commands/social/inbox/analytics/conversations): List or inspect per-conversation inbox analytics

## Complete command help

```text
Usage: smallforce social inbox analytics [options] [command]

Inspect inbox volume, activity timing, sources, response time, accounts, and conversations

Options:
  -h, --help               display help for command

Commands:
  volume [options]         Show sent and received volume
  heatmap [options]        Show inbox activity by weekday and hour
  sources [options]        Break inbox activity down by message source
  response-time [options]  Show inbox response-time percentiles and histogram
  top-accounts [options]   Rank inbox accounts by message activity
  conversations            List or inspect per-conversation inbox analytics
  help [command]           display help for command
```

## Related reference

- [`smallforce social inbox`](/docs/cli/commands/social/inbox): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/social/inbox/analytics/volume -->

# `smallforce social inbox analytics volume`

Show sent and received volume

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce social inbox analytics volume --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce social inbox analytics volume [options]

Show sent and received volume

Options:
  --from <date>          Inclusive start date in YYYY-MM-DD
  --to <date>            Inclusive end date in YYYY-MM-DD
  --account <accountId>  Account id from social accounts list
  --profile <profileId>  Profile id from social profiles list
  --platform <platform>  Platform key
  --source <source>      api, broadcast, comment_automation, contact, human, platform, sequence, or
                         workflow
  --api-key <key>        SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>    SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                 Print stable machine-readable JSON
  --text                 Print human-readable text
  --format <format>      Output format: text or json
  -h, --help             display help for command
```

## Related reference

- [`smallforce social inbox analytics`](/docs/cli/commands/social/inbox/analytics): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/social/inbox/analytics/heatmap -->

# `smallforce social inbox analytics heatmap`

Show inbox activity by weekday and hour

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce social inbox analytics heatmap --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce social inbox analytics heatmap [options]

Show inbox activity by weekday and hour

Options:
  --action <action>      all, message.received, message.sent, or message.read
  --from <date>          Inclusive start date in YYYY-MM-DD
  --to <date>            Inclusive end date in YYYY-MM-DD
  --account <accountId>  Account id from social accounts list
  --profile <profileId>  Profile id from social profiles list
  --platform <platform>  Platform key
  --source <source>      api, broadcast, comment_automation, contact, human, platform, sequence, or
                         workflow
  --api-key <key>        SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>    SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                 Print stable machine-readable JSON
  --text                 Print human-readable text
  --format <format>      Output format: text or json
  -h, --help             display help for command
```

## Related reference

- [`smallforce social inbox analytics`](/docs/cli/commands/social/inbox/analytics): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/social/inbox/analytics/sources -->

# `smallforce social inbox analytics sources`

Break inbox activity down by message source

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce social inbox analytics sources --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce social inbox analytics sources [options]

Break inbox activity down by message source

Options:
  --from <date>          Inclusive start date in YYYY-MM-DD
  --to <date>            Inclusive end date in YYYY-MM-DD
  --account <accountId>  Account id from social accounts list
  --profile <profileId>  Profile id from social profiles list
  --platform <platform>  Platform key
  --api-key <key>        SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>    SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                 Print stable machine-readable JSON
  --text                 Print human-readable text
  --format <format>      Output format: text or json
  -h, --help             display help for command
```

## Related reference

- [`smallforce social inbox analytics`](/docs/cli/commands/social/inbox/analytics): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/social/inbox/analytics/response-time -->

# `smallforce social inbox analytics response-time`

Show inbox response-time percentiles and histogram

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce social inbox analytics response-time --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce social inbox analytics response-time [options]

Show inbox response-time percentiles and histogram

Options:
  --from <date>          Inclusive start date in YYYY-MM-DD
  --to <date>            Inclusive end date in YYYY-MM-DD
  --account <accountId>  Account id from social accounts list
  --profile <profileId>  Profile id from social profiles list
  --platform <platform>  Platform key
  --api-key <key>        SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>    SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                 Print stable machine-readable JSON
  --text                 Print human-readable text
  --format <format>      Output format: text or json
  -h, --help             display help for command
```

## Related reference

- [`smallforce social inbox analytics`](/docs/cli/commands/social/inbox/analytics): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/social/inbox/analytics/top-accounts -->

# `smallforce social inbox analytics top-accounts`

Rank inbox accounts by message activity

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce social inbox analytics top-accounts --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce social inbox analytics top-accounts [options]

Rank inbox accounts by message activity

Options:
  --limit <n>            Maximum accounts from 1 to 100
  --from <date>          Inclusive start date in YYYY-MM-DD
  --to <date>            Inclusive end date in YYYY-MM-DD
  --account <accountId>  Account id from social accounts list
  --profile <profileId>  Profile id from social profiles list
  --platform <platform>  Platform key
  --source <source>      api, broadcast, comment_automation, contact, human, platform, sequence, or
                         workflow
  --api-key <key>        SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>    SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                 Print stable machine-readable JSON
  --text                 Print human-readable text
  --format <format>      Output format: text or json
  -h, --help             display help for command
```

## Related reference

- [`smallforce social inbox analytics`](/docs/cli/commands/social/inbox/analytics): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/social/inbox/analytics/conversations -->

# `smallforce social inbox analytics conversations`

List or inspect per-conversation inbox analytics

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce social inbox analytics conversations --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce social inbox analytics conversations list`](/docs/cli/commands/social/inbox/analytics/conversations/list): List conversation-level inbox metrics
- [`smallforce social inbox analytics conversations get`](/docs/cli/commands/social/inbox/analytics/conversations/get): Show analytics for one SmallForce conversation id

## Complete command help

```text
Usage: smallforce social inbox analytics conversations [options] [command]

List or inspect per-conversation inbox analytics

Options:
  -h, --help                      display help for command

Commands:
  list [options]                  List conversation-level inbox metrics
  get [options] <conversationId>  Show analytics for one SmallForce conversation id
  help [command]                  display help for command
```

## Related reference

- [`smallforce social inbox analytics`](/docs/cli/commands/social/inbox/analytics): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/social/inbox/analytics/conversations/list -->

# `smallforce social inbox analytics conversations list`

List conversation-level inbox metrics

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce social inbox analytics conversations list --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce social inbox analytics conversations list [options]

List conversation-level inbox metrics

Options:
  --limit <n>            Page size from 1 to 100
  --page <n>             Page number
  --order <order>        asc or desc
  --sort-by <metric>     lastMessageAt, firstMessageAt, totalMessages, received, sent, read, or
                         failed
  --from <date>          Inclusive start date in YYYY-MM-DD
  --to <date>            Inclusive end date in YYYY-MM-DD
  --account <accountId>  Account id from social accounts list
  --profile <profileId>  Profile id from social profiles list
  --platform <platform>  Platform key
  --source <source>      api, broadcast, comment_automation, contact, human, platform, sequence, or
                         workflow
  --api-key <key>        SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>    SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                 Print stable machine-readable JSON
  --text                 Print human-readable text
  --format <format>      Output format: text or json
  -h, --help             display help for command
```

## Related reference

- [`smallforce social inbox analytics conversations`](/docs/cli/commands/social/inbox/analytics/conversations): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/social/inbox/analytics/conversations/get -->

# `smallforce social inbox analytics conversations get`

Show analytics for one SmallForce conversation id

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce social inbox analytics conversations get --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce social inbox analytics conversations get [options] <conversationId>

Show analytics for one SmallForce conversation id

Arguments:
  conversationId       Conversation id from social inbox conversations list

Options:
  --from <date>        Inclusive start date in YYYY-MM-DD
  --to <date>          Inclusive end date in YYYY-MM-DD
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  -h, --help           display help for command
```

## Related reference

- [`smallforce social inbox analytics conversations`](/docs/cli/commands/social/inbox/analytics/conversations): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/social/inbox/conversations -->

# `smallforce social inbox conversations`

List and manage inbox conversations

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce social inbox conversations --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce social inbox conversations list`](/docs/cli/commands/social/inbox/conversations/list): List organization-owned inbox conversations and conversation IDs
- [`smallforce social inbox conversations get`](/docs/cli/commands/social/inbox/conversations/get): Refresh and get one organization-owned conversation
- [`smallforce social inbox conversations read`](/docs/cli/commands/social/inbox/conversations/read): Mark one conversation read at the provider and locally

## Complete command help

```text
Usage: smallforce social inbox conversations [options] [command]

List and manage inbox conversations

Options:
  -h, --help                       display help for command

Commands:
  list [options]                   List organization-owned inbox conversations and conversation IDs
  get [options] <conversationId>   Refresh and get one organization-owned conversation
  read [options] <conversationId>  Mark one conversation read at the provider and locally
  help [command]                   display help for command
```

## Related reference

- [`smallforce social inbox`](/docs/cli/commands/social/inbox): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/social/inbox/conversations/list -->

# `smallforce social inbox conversations list`

List organization-owned inbox conversations and conversation IDs

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce social inbox conversations list --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce social inbox conversations list [options]

List organization-owned inbox conversations and conversation IDs

Options:
  --account <accountId>  Account id from social accounts list
  --profile <profileId>  Profile id from social profiles list
  --platform <platform>  Platform key from social platforms list
  --status <status>      active or archived
  --limit <n>            Page size from 1 to 250
  --cursor <cursor>      Opaque cursor returned by the previous page
  --include-deleted      Include deleted conversations
  --api-key <key>        SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>    SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                 Print stable machine-readable JSON
  --text                 Print human-readable text
  --format <format>      Output format: text or json
  -h, --help             display help for command
```

## Related reference

- [`smallforce social inbox conversations`](/docs/cli/commands/social/inbox/conversations): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/social/inbox/conversations/get -->

# `smallforce social inbox conversations get`

Refresh and get one organization-owned conversation

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce social inbox conversations get --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce social inbox conversations get [options] <conversationId>

Refresh and get one organization-owned conversation

Arguments:
  conversationId       Conversation id from inbox conversations list

Options:
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  -h, --help           display help for command
```

## Related reference

- [`smallforce social inbox conversations`](/docs/cli/commands/social/inbox/conversations): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/social/inbox/conversations/read -->

# `smallforce social inbox conversations read`

Mark one conversation read at the provider and locally

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce social inbox conversations read --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce social inbox conversations read [options] <conversationId>

Mark one conversation read at the provider and locally

Arguments:
  conversationId       Conversation id from inbox conversations list

Options:
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  -h, --help           display help for command
```

## Related reference

- [`smallforce social inbox conversations`](/docs/cli/commands/social/inbox/conversations): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/social/inbox/messages -->

# `smallforce social inbox messages`

List and send messages inside a conversation

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce social inbox messages --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce social inbox messages list`](/docs/cli/commands/social/inbox/messages/list): List messages for one organization-owned conversation
- [`smallforce social inbox messages send`](/docs/cli/commands/social/inbox/messages/send): Send text, an attachment, quick replies, buttons, a template, or an interactive payload

## Complete command help

```text
Usage: smallforce social inbox messages [options] [command]

List and send messages inside a conversation

Options:
  -h, --help                       display help for command

Commands:
  list [options] <conversationId>  List messages for one organization-owned conversation
  send [options] <conversationId>  Send text, an attachment, quick replies, buttons, a template, or
                                   an interactive payload
  help [command]                   display help for command
```

## Related reference

- [`smallforce social inbox`](/docs/cli/commands/social/inbox): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/social/inbox/messages/list -->

# `smallforce social inbox messages list`

List messages for one organization-owned conversation

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce social inbox messages list --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce social inbox messages list [options] <conversationId>

List messages for one organization-owned conversation

Arguments:
  conversationId       Conversation id from inbox conversations list

Options:
  --limit <n>          Page size from 1 to 100
  --cursor <cursor>    Provider cursor returned by the previous page
  --order <order>      asc or desc
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  -h, --help           display help for command
```

## Related reference

- [`smallforce social inbox messages`](/docs/cli/commands/social/inbox/messages): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/social/inbox/messages/send -->

# `smallforce social inbox messages send`

Send text, an attachment, quick replies, buttons, a template, or an interactive payload

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce social inbox messages send --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce social inbox messages send [options] <conversationId>

Send text, an attachment, quick replies, buttons, a template, or an interactive payload

Arguments:
  conversationId            Conversation id from inbox conversations list

Options:
  --message <text>          Message text
  --attachment-url <url>    Public attachment URL
  --attachment-name <name>  Attachment filename
  --attachment-type <type>  image, video, audio, or file
  --reply-to <messageId>    Provider message id being replied to
  --voice-note              Send an audio attachment as a voice note
  --quick-reply <json>      Quick-reply object; repeatable (default: [])
  --button <json>           Button object; repeatable (default: [])
  --template <json>         Provider template object
  --interactive <json>      Provider interactive-message object
  --api-key <key>           SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>       SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                    Print stable machine-readable JSON
  --text                    Print human-readable text
  --format <format>         Output format: text or json
  -h, --help                display help for command
```

## Related reference

- [`smallforce social inbox messages`](/docs/cli/commands/social/inbox/messages): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/social/reviews -->

# `smallforce social reviews`

List Facebook and Google Business reviews and manage replies

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce social reviews --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce social reviews list`](/docs/cli/commands/social/reviews/list): List reviews, ratings, reply state, and review IDs
- [`smallforce social reviews get`](/docs/cli/commands/social/reviews/get): Get one organization-owned review
- [`smallforce social reviews reply`](/docs/cli/commands/social/reviews/reply): Publish or replace the reply to one review
- [`smallforce social reviews delete-reply`](/docs/cli/commands/social/reviews/delete-reply): Delete the existing provider reply from one review

## Complete command help

```text
Usage: smallforce social reviews [options] [command]

List Facebook and Google Business reviews and manage replies

Options:
  -h, --help                         display help for command

Commands:
  list [options]                     List reviews, ratings, reply state, and review IDs
  get [options] <reviewId>           Get one organization-owned review
  reply [options] <reviewId>         Publish or replace the reply to one review
  delete-reply [options] <reviewId>  Delete the existing provider reply from one review
  help [command]                     display help for command
```

## Related reference

- [`smallforce social`](/docs/cli/commands/social): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/social/reviews/list -->

# `smallforce social reviews list`

List reviews, ratings, reply state, and review IDs

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce social reviews list --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce social reviews list [options]

List reviews, ratings, reply state, and review IDs

Options:
  --account <accountId>     Account id from social accounts list
  --profile <profileId>     Profile id from social profiles list
  --platform <platform>     facebook or google_business
  --has-reply <true|false>  Filter by reply state
  --min-rating <1-5>        Minimum rating
  --max-rating <1-5>        Maximum rating
  --sort <field>            date or rating
  --order <order>           asc or desc
  --limit <n>               Page size from 1 to 50
  --cursor <cursor>         Opaque cursor returned by the previous page
  --api-key <key>           SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>       SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                    Print stable machine-readable JSON
  --text                    Print human-readable text
  --format <format>         Output format: text or json
  -h, --help                display help for command
```

## Related reference

- [`smallforce social reviews`](/docs/cli/commands/social/reviews): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/social/reviews/get -->

# `smallforce social reviews get`

Get one organization-owned review

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce social reviews get --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce social reviews get [options] <reviewId>

Get one organization-owned review

Arguments:
  reviewId             Review id from social reviews list

Options:
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  -h, --help           display help for command
```

## Related reference

- [`smallforce social reviews`](/docs/cli/commands/social/reviews): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/social/reviews/reply -->

# `smallforce social reviews reply`

Publish or replace the reply to one review

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce social reviews reply --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce social reviews reply [options] <reviewId>

Publish or replace the reply to one review

Arguments:
  reviewId             Review id from social reviews list

Options:
  --message <text>     Reply text
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  -h, --help           display help for command
```

## Related reference

- [`smallforce social reviews`](/docs/cli/commands/social/reviews): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/social/reviews/delete-reply -->

# `smallforce social reviews delete-reply`

Delete the existing provider reply from one review

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce social reviews delete-reply --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce social reviews delete-reply [options] <reviewId>

Delete the existing provider reply from one review

Arguments:
  reviewId             Review id from social reviews list

Options:
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  -h, --help           display help for command
```

## Related reference

- [`smallforce social reviews`](/docs/cli/commands/social/reviews): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/social/sync -->

# `smallforce social sync`

Refresh provider profiles, accounts, posts, and external posts into SmallForce

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce social sync --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce social sync accounts`](/docs/cli/commands/social/sync/accounts): Refresh connected social accounts and destinations
- [`smallforce social sync profiles`](/docs/cli/commands/social/sync/profiles): Refresh provider profile metadata
- [`smallforce social sync posts`](/docs/cli/commands/social/sync/posts): Import a page of provider posts for one or all organization profiles
- [`smallforce social sync post`](/docs/cli/commands/social/sync/post): Refresh exactly one organization-owned post
- [`smallforce social sync external-posts`](/docs/cli/commands/social/sync/external-posts): Import provider-created content for one organization-owned account

## Complete command help

```text
Usage: smallforce social sync [options] [command]

Refresh provider profiles, accounts, posts, and external posts into SmallForce

Options:
  -h, --help                display help for command

Commands:
  accounts [options]        Refresh connected social accounts and destinations
  profiles [options]        Refresh provider profile metadata
  posts [options]           Import a page of provider posts for one or all organization profiles
  post [options]            Refresh exactly one organization-owned post
  external-posts [options]  Import provider-created content for one organization-owned account
  help [command]            display help for command
```

## Related reference

- [`smallforce social`](/docs/cli/commands/social): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/social/sync/accounts -->

# `smallforce social sync accounts`

Refresh connected social accounts and destinations

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce social sync accounts --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce social sync accounts [options]

Refresh connected social accounts and destinations

Options:
  --profile <profileId>  Restrict sync to one profile id
  --api-key <key>        SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>    SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                 Print stable machine-readable JSON
  --text                 Print human-readable text
  --format <format>      Output format: text or json
  -h, --help             display help for command
```

## Related reference

- [`smallforce social sync`](/docs/cli/commands/social/sync): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/social/sync/profiles -->

# `smallforce social sync profiles`

Refresh provider profile metadata

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce social sync profiles --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce social sync profiles [options]

Refresh provider profile metadata

Options:
  --profile <profileId>  Restrict sync to one local profile id
  --api-key <key>        SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>    SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                 Print stable machine-readable JSON
  --text                 Print human-readable text
  --format <format>      Output format: text or json
  -h, --help             display help for command
```

## Related reference

- [`smallforce social sync`](/docs/cli/commands/social/sync): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/social/sync/posts -->

# `smallforce social sync posts`

Import a page of provider posts for one or all organization profiles

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce social sync posts --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce social sync posts [options]

Import a page of provider posts for one or all organization profiles

Options:
  --profile <profileId>  Restrict sync to one profile
  --status <status>      draft, scheduled, published, or failed
  --limit <n>            Provider page size from 1 to 250
  --page <n>             Provider page number
  --no-sync-accounts     Do not refresh accounts before post sync
  --api-key <key>        SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>    SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                 Print stable machine-readable JSON
  --text                 Print human-readable text
  --format <format>      Output format: text or json
  -h, --help             display help for command
```

## Related reference

- [`smallforce social sync`](/docs/cli/commands/social/sync): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/social/sync/post -->

# `smallforce social sync post`

Refresh exactly one organization-owned post

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce social sync post --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce social sync post [options]

Refresh exactly one organization-owned post

Options:
  --post <postId>                   Local post id from social posts list
  --provider-post <providerPostId>  Provider post id that belongs to an organization account or
                                    profile
  --api-key <key>                   SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>               SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                            Print stable machine-readable JSON
  --text                            Print human-readable text
  --format <format>                 Output format: text or json
  -h, --help                        display help for command
```

## Related reference

- [`smallforce social sync`](/docs/cli/commands/social/sync): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/social/sync/external-posts -->

# `smallforce social sync external-posts`

Import provider-created content for one organization-owned account

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce social sync external-posts --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce social sync external-posts [options]

Import provider-created content for one organization-owned account

Options:
  --account <accountId>             Account id from social accounts list
  --platform-post <providerPostId>  Optional exact provider post id
  --url <postUrl>                   Optional public post URL
  --api-key <key>                   SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>               SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                            Print stable machine-readable JSON
  --text                            Print human-readable text
  --format <format>                 Output format: text or json
  -h, --help                        display help for command
```

## Related reference

- [`smallforce social sync`](/docs/cli/commands/social/sync): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/social/analytics -->

# `smallforce social analytics`

Inspect cross-platform, post-level, and provider-specific social analytics

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce social analytics --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce social analytics daily`](/docs/cli/commands/social/analytics/daily): Get daily cross-platform social metrics
- [`smallforce social analytics best-time`](/docs/cli/commands/social/analytics/best-time): Get provider recommendations for the best time to publish
- [`smallforce social analytics content-decay`](/docs/cli/commands/social/analytics/content-decay): Measure how quickly published content loses engagement
- [`smallforce social analytics posting-frequency`](/docs/cli/commands/social/analytics/posting-frequency): Inspect posting-frequency patterns
- [`smallforce social analytics followers`](/docs/cli/commands/social/analytics/followers): Get follower counts and growth history
- [`smallforce social analytics posts`](/docs/cli/commands/social/analytics/posts): List analytics across posts or inspect one post timeline
- [`smallforce social analytics facebook`](/docs/cli/commands/social/analytics/facebook): Facebook Page analytics
- [`smallforce social analytics instagram`](/docs/cli/commands/social/analytics/instagram): Instagram account, follower, and demographic analytics
- [`smallforce social analytics youtube`](/docs/cli/commands/social/analytics/youtube): YouTube channel and demographic analytics
- [`smallforce social analytics tiktok`](/docs/cli/commands/social/analytics/tiktok): TikTok account analytics
- [`smallforce social analytics linkedin`](/docs/cli/commands/social/analytics/linkedin): LinkedIn aggregate and organization analytics

## Complete command help

```text
Usage: smallforce social analytics [options] [command]

Inspect cross-platform, post-level, and provider-specific social analytics

Options:
  -h, --help                   display help for command

Commands:
  daily [options]              Get daily cross-platform social metrics
  best-time [options]          Get provider recommendations for the best time to publish
  content-decay [options]      Measure how quickly published content loses engagement
  posting-frequency [options]  Inspect posting-frequency patterns
  followers [options]          Get follower counts and growth history
  posts                        List analytics across posts or inspect one post timeline
  facebook                     Facebook Page analytics
  instagram                    Instagram account, follower, and demographic analytics
  youtube                      YouTube channel and demographic analytics
  tiktok                       TikTok account analytics
  linkedin                     LinkedIn aggregate and organization analytics
  help [command]               display help for command
```

## Related reference

- [`smallforce social`](/docs/cli/commands/social): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/social/analytics/daily -->

# `smallforce social analytics daily`

Get daily cross-platform social metrics

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce social analytics daily --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce social analytics daily [options]

Get daily cross-platform social metrics

Options:
  --account <accountId>  Scope to one account id from social accounts list
  --profile <profileId>  Scope to one profile id from social profiles list
  --platform <platform>  Scope to one platform key
  --source <source>      all, smallforce, or external
  --from <YYYY-MM-DD>    Inclusive start date
  --to <YYYY-MM-DD>      Inclusive end date
  --api-key <key>        SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>    SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                 Print stable machine-readable JSON
  --text                 Print human-readable text
  --format <format>      Output format: text or json
  -h, --help             display help for command
```

## Related reference

- [`smallforce social analytics`](/docs/cli/commands/social/analytics): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/social/analytics/best-time -->

# `smallforce social analytics best-time`

Get provider recommendations for the best time to publish

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce social analytics best-time --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce social analytics best-time [options]

Get provider recommendations for the best time to publish

Options:
  --account <accountId>  Scope to one account id from social accounts list
  --profile <profileId>  Scope to one profile id from social profiles list
  --platform <platform>  Scope to one platform key
  --source <source>      all, smallforce, or external
  --api-key <key>        SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>    SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                 Print stable machine-readable JSON
  --text                 Print human-readable text
  --format <format>      Output format: text or json
  -h, --help             display help for command
```

## Related reference

- [`smallforce social analytics`](/docs/cli/commands/social/analytics): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/social/analytics/content-decay -->

# `smallforce social analytics content-decay`

Measure how quickly published content loses engagement

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce social analytics content-decay --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce social analytics content-decay [options]

Measure how quickly published content loses engagement

Options:
  --account <accountId>  Scope to one account id from social accounts list
  --profile <profileId>  Scope to one profile id from social profiles list
  --platform <platform>  Scope to one platform key
  --source <source>      all, smallforce, or external
  --api-key <key>        SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>    SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                 Print stable machine-readable JSON
  --text                 Print human-readable text
  --format <format>      Output format: text or json
  -h, --help             display help for command
```

## Related reference

- [`smallforce social analytics`](/docs/cli/commands/social/analytics): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/social/analytics/posting-frequency -->

# `smallforce social analytics posting-frequency`

Inspect posting-frequency patterns

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce social analytics posting-frequency --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce social analytics posting-frequency [options]

Inspect posting-frequency patterns

Options:
  --account <accountId>  Scope to one account id from social accounts list
  --profile <profileId>  Scope to one profile id from social profiles list
  --platform <platform>  Scope to one platform key
  --source <source>      all, smallforce, or external
  --api-key <key>        SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>    SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                 Print stable machine-readable JSON
  --text                 Print human-readable text
  --format <format>      Output format: text or json
  -h, --help             display help for command
```

## Related reference

- [`smallforce social analytics`](/docs/cli/commands/social/analytics): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/social/analytics/followers -->

# `smallforce social analytics followers`

Get follower counts and growth history

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce social analytics followers --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce social analytics followers [options]

Get follower counts and growth history

Options:
  --granularity <value>  daily, weekly, or monthly
  --account <accountId>  Scope to one account id from social accounts list
  --profile <profileId>  Scope to one profile id from social profiles list
  --platform <platform>  Scope to one platform key
  --from <YYYY-MM-DD>    Inclusive start date
  --to <YYYY-MM-DD>      Inclusive end date
  --api-key <key>        SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>    SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                 Print stable machine-readable JSON
  --text                 Print human-readable text
  --format <format>      Output format: text or json
  -h, --help             display help for command
```

## Related reference

- [`smallforce social analytics`](/docs/cli/commands/social/analytics): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/social/analytics/posts -->

# `smallforce social analytics posts`

List analytics across posts or inspect one post timeline

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce social analytics posts --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce social analytics posts list`](/docs/cli/commands/social/analytics/posts/list): List post analytics with sorting and pagination
- [`smallforce social analytics posts get`](/docs/cli/commands/social/analytics/posts/get): Get aggregate analytics for one SmallForce post
- [`smallforce social analytics posts timeline`](/docs/cli/commands/social/analytics/posts/timeline): Get time-series analytics for one SmallForce post

## Complete command help

```text
Usage: smallforce social analytics posts [options] [command]

List analytics across posts or inspect one post timeline

Options:
  -h, --help                   display help for command

Commands:
  list [options]               List post analytics with sorting and pagination
  get [options] <postId>       Get aggregate analytics for one SmallForce post
  timeline [options] <postId>  Get time-series analytics for one SmallForce post
  help [command]               display help for command
```

## Related reference

- [`smallforce social analytics`](/docs/cli/commands/social/analytics): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/social/analytics/posts/list -->

# `smallforce social analytics posts list`

List post analytics with sorting and pagination

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce social analytics posts list --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce social analytics posts list [options]

List post analytics with sorting and pagination

Options:
  --sort <field>         date, engagement, impressions, reach, likes, comments, shares, saves,
                         clicks, or views
  --order <order>        asc or desc
  --limit <n>            Page size from 1 to 250
  --page <n>             Provider page number
  --account <accountId>  Scope to one account id from social accounts list
  --profile <profileId>  Scope to one profile id from social profiles list
  --platform <platform>  Scope to one platform key
  --source <source>      all, smallforce, or external
  --from <YYYY-MM-DD>    Inclusive start date
  --to <YYYY-MM-DD>      Inclusive end date
  --api-key <key>        SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>    SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                 Print stable machine-readable JSON
  --text                 Print human-readable text
  --format <format>      Output format: text or json
  -h, --help             display help for command
```

## Related reference

- [`smallforce social analytics posts`](/docs/cli/commands/social/analytics/posts): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/social/analytics/posts/get -->

# `smallforce social analytics posts get`

Get aggregate analytics for one SmallForce post

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce social analytics posts get --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce social analytics posts get [options] <postId>

Get aggregate analytics for one SmallForce post

Arguments:
  postId               Post id from social posts list

Options:
  --from <YYYY-MM-DD>  Inclusive start date
  --to <YYYY-MM-DD>    Inclusive end date
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  -h, --help           display help for command
```

## Related reference

- [`smallforce social analytics posts`](/docs/cli/commands/social/analytics/posts): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/social/analytics/posts/timeline -->

# `smallforce social analytics posts timeline`

Get time-series analytics for one SmallForce post

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce social analytics posts timeline --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce social analytics posts timeline [options] <postId>

Get time-series analytics for one SmallForce post

Arguments:
  postId               Post id from social posts list

Options:
  --from <YYYY-MM-DD>  Inclusive start date
  --to <YYYY-MM-DD>    Inclusive end date
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  -h, --help           display help for command
```

## Related reference

- [`smallforce social analytics posts`](/docs/cli/commands/social/analytics/posts): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/social/analytics/facebook -->

# `smallforce social analytics facebook`

Facebook Page analytics

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce social analytics facebook --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce social analytics facebook page-insights`](/docs/cli/commands/social/analytics/facebook/page-insights): Get Facebook Page insights

## Complete command help

```text
Usage: smallforce social analytics facebook [options] [command]

Facebook Page analytics

Options:
  -h, --help                           display help for command

Commands:
  page-insights [options] <accountId>  Get Facebook Page insights
  help [command]                       display help for command
```

## Related reference

- [`smallforce social analytics`](/docs/cli/commands/social/analytics): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/social/analytics/facebook/page-insights -->

# `smallforce social analytics facebook page-insights`

Get Facebook Page insights

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce social analytics facebook page-insights --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce social analytics facebook page-insights [options] <accountId>

Get Facebook Page insights

Arguments:
  accountId              Account id from social accounts list

Options:
  --from <YYYY-MM-DD>    Inclusive start date
  --to <YYYY-MM-DD>      Inclusive end date
  --metrics <csv>        Provider metric names as one comma-separated string
  --breakdown <value>    Provider-supported breakdown
  --metric-type <value>  time_series or total_value
  --api-key <key>        SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>    SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                 Print stable machine-readable JSON
  --text                 Print human-readable text
  --format <format>      Output format: text or json
  -h, --help             display help for command
```

## Related reference

- [`smallforce social analytics facebook`](/docs/cli/commands/social/analytics/facebook): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/social/analytics/instagram -->

# `smallforce social analytics instagram`

Instagram account, follower, and demographic analytics

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce social analytics instagram --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce social analytics instagram account-insights`](/docs/cli/commands/social/analytics/instagram/account-insights): Get Instagram professional-account insights
- [`smallforce social analytics instagram follower-history`](/docs/cli/commands/social/analytics/instagram/follower-history): Get Instagram follower history
- [`smallforce social analytics instagram demographics`](/docs/cli/commands/social/analytics/instagram/demographics): Get Instagram follower or engaged-audience demographics

## Complete command help

```text
Usage: smallforce social analytics instagram [options] [command]

Instagram account, follower, and demographic analytics

Options:
  -h, --help                              display help for command

Commands:
  account-insights [options] <accountId>  Get Instagram professional-account insights
  follower-history [options] <accountId>  Get Instagram follower history
  demographics [options] <accountId>      Get Instagram follower or engaged-audience demographics
  help [command]                          display help for command
```

## Related reference

- [`smallforce social analytics`](/docs/cli/commands/social/analytics): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/social/analytics/instagram/account-insights -->

# `smallforce social analytics instagram account-insights`

Get Instagram professional-account insights

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce social analytics instagram account-insights --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce social analytics instagram account-insights [options] <accountId>

Get Instagram professional-account insights

Arguments:
  accountId              Account id from social accounts list

Options:
  --from <YYYY-MM-DD>    Inclusive start date
  --to <YYYY-MM-DD>      Inclusive end date
  --metrics <csv>        Provider metric names as one comma-separated string
  --breakdown <value>    Provider-supported breakdown
  --metric-type <value>  time_series or total_value
  --api-key <key>        SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>    SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                 Print stable machine-readable JSON
  --text                 Print human-readable text
  --format <format>      Output format: text or json
  -h, --help             display help for command
```

## Related reference

- [`smallforce social analytics instagram`](/docs/cli/commands/social/analytics/instagram): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/social/analytics/instagram/follower-history -->

# `smallforce social analytics instagram follower-history`

Get Instagram follower history

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce social analytics instagram follower-history --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce social analytics instagram follower-history [options] <accountId>

Get Instagram follower history

Arguments:
  accountId              Account id from social accounts list

Options:
  --from <YYYY-MM-DD>    Inclusive start date
  --to <YYYY-MM-DD>      Inclusive end date
  --metrics <csv>        Provider metric names as one comma-separated string
  --breakdown <value>    Provider-supported breakdown
  --metric-type <value>  time_series or total_value
  --api-key <key>        SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>    SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                 Print stable machine-readable JSON
  --text                 Print human-readable text
  --format <format>      Output format: text or json
  -h, --help             display help for command
```

## Related reference

- [`smallforce social analytics instagram`](/docs/cli/commands/social/analytics/instagram): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/social/analytics/instagram/demographics -->

# `smallforce social analytics instagram demographics`

Get Instagram follower or engaged-audience demographics

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce social analytics instagram demographics --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce social analytics instagram demographics [options] <accountId>

Get Instagram follower or engaged-audience demographics

Arguments:
  accountId            Instagram account id from social accounts list

Options:
  --metric <value>     follower_demographics or engaged_audience_demographics
  --timeframe <value>  this_week or this_month
  --breakdown <value>  Provider-supported demographic breakdown
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  -h, --help           display help for command
```

## Related reference

- [`smallforce social analytics instagram`](/docs/cli/commands/social/analytics/instagram): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/social/analytics/youtube -->

# `smallforce social analytics youtube`

YouTube channel and demographic analytics

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce social analytics youtube --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce social analytics youtube channel-insights`](/docs/cli/commands/social/analytics/youtube/channel-insights): Get YouTube channel insights
- [`smallforce social analytics youtube demographics`](/docs/cli/commands/social/analytics/youtube/demographics): Get YouTube channel demographics

## Complete command help

```text
Usage: smallforce social analytics youtube [options] [command]

YouTube channel and demographic analytics

Options:
  -h, --help                              display help for command

Commands:
  channel-insights [options] <accountId>  Get YouTube channel insights
  demographics [options] <accountId>      Get YouTube channel demographics
  help [command]                          display help for command
```

## Related reference

- [`smallforce social analytics`](/docs/cli/commands/social/analytics): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/social/analytics/youtube/channel-insights -->

# `smallforce social analytics youtube channel-insights`

Get YouTube channel insights

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce social analytics youtube channel-insights --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce social analytics youtube channel-insights [options] <accountId>

Get YouTube channel insights

Arguments:
  accountId              Account id from social accounts list

Options:
  --from <YYYY-MM-DD>    Inclusive start date
  --to <YYYY-MM-DD>      Inclusive end date
  --metrics <csv>        Provider metric names as one comma-separated string
  --breakdown <value>    Provider-supported breakdown
  --metric-type <value>  time_series or total_value
  --api-key <key>        SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>    SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                 Print stable machine-readable JSON
  --text                 Print human-readable text
  --format <format>      Output format: text or json
  -h, --help             display help for command
```

## Related reference

- [`smallforce social analytics youtube`](/docs/cli/commands/social/analytics/youtube): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/social/analytics/youtube/demographics -->

# `smallforce social analytics youtube demographics`

Get YouTube channel demographics

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce social analytics youtube demographics --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce social analytics youtube demographics [options] <accountId>

Get YouTube channel demographics

Arguments:
  accountId            YouTube account id from social accounts list

Options:
  --from <YYYY-MM-DD>  Inclusive start date
  --to <YYYY-MM-DD>    Inclusive end date
  --breakdown <value>  Provider-supported demographic breakdown
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  -h, --help           display help for command
```

## Related reference

- [`smallforce social analytics youtube`](/docs/cli/commands/social/analytics/youtube): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/social/analytics/tiktok -->

# `smallforce social analytics tiktok`

TikTok account analytics

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce social analytics tiktok --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce social analytics tiktok account-insights`](/docs/cli/commands/social/analytics/tiktok/account-insights): Get TikTok account insights

## Complete command help

```text
Usage: smallforce social analytics tiktok [options] [command]

TikTok account analytics

Options:
  -h, --help                              display help for command

Commands:
  account-insights [options] <accountId>  Get TikTok account insights
  help [command]                          display help for command
```

## Related reference

- [`smallforce social analytics`](/docs/cli/commands/social/analytics): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/social/analytics/tiktok/account-insights -->

# `smallforce social analytics tiktok account-insights`

Get TikTok account insights

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce social analytics tiktok account-insights --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce social analytics tiktok account-insights [options] <accountId>

Get TikTok account insights

Arguments:
  accountId              Account id from social accounts list

Options:
  --from <YYYY-MM-DD>    Inclusive start date
  --to <YYYY-MM-DD>      Inclusive end date
  --metrics <csv>        Provider metric names as one comma-separated string
  --breakdown <value>    Provider-supported breakdown
  --metric-type <value>  time_series or total_value
  --api-key <key>        SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>    SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                 Print stable machine-readable JSON
  --text                 Print human-readable text
  --format <format>      Output format: text or json
  -h, --help             display help for command
```

## Related reference

- [`smallforce social analytics tiktok`](/docs/cli/commands/social/analytics/tiktok): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/social/analytics/linkedin -->

# `smallforce social analytics linkedin`

LinkedIn aggregate and organization analytics

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce social analytics linkedin --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce social analytics linkedin aggregate`](/docs/cli/commands/social/analytics/linkedin/aggregate): Get LinkedIn aggregate analytics
- [`smallforce social analytics linkedin organization-aggregate`](/docs/cli/commands/social/analytics/linkedin/organization-aggregate): Get LinkedIn organization aggregate analytics

## Complete command help

```text
Usage: smallforce social analytics linkedin [options] [command]

LinkedIn aggregate and organization analytics

Options:
  -h, --help                                    display help for command

Commands:
  aggregate [options] <accountId>               Get LinkedIn aggregate analytics
  organization-aggregate [options] <accountId>  Get LinkedIn organization aggregate analytics
  help [command]                                display help for command
```

## Related reference

- [`smallforce social analytics`](/docs/cli/commands/social/analytics): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/social/analytics/linkedin/aggregate -->

# `smallforce social analytics linkedin aggregate`

Get LinkedIn aggregate analytics

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce social analytics linkedin aggregate --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce social analytics linkedin aggregate [options] <accountId>

Get LinkedIn aggregate analytics

Arguments:
  accountId              LinkedIn account id from social accounts list

Options:
  --from <YYYY-MM-DD>    Inclusive start date
  --to <YYYY-MM-DD>      Inclusive end date
  --metrics <csv>        Provider metric names
  --aggregation <value>  TOTAL or DAILY
  --api-key <key>        SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>    SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                 Print stable machine-readable JSON
  --text                 Print human-readable text
  --format <format>      Output format: text or json
  -h, --help             display help for command
```

## Related reference

- [`smallforce social analytics linkedin`](/docs/cli/commands/social/analytics/linkedin): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/social/analytics/linkedin/organization-aggregate -->

# `smallforce social analytics linkedin organization-aggregate`

Get LinkedIn organization aggregate analytics

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce social analytics linkedin organization-aggregate --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce social analytics linkedin organization-aggregate [options] <accountId>

Get LinkedIn organization aggregate analytics

Arguments:
  accountId              Account id from social accounts list

Options:
  --from <YYYY-MM-DD>    Inclusive start date
  --to <YYYY-MM-DD>      Inclusive end date
  --metrics <csv>        Provider metric names as one comma-separated string
  --breakdown <value>    Provider-supported breakdown
  --metric-type <value>  time_series or total_value
  --api-key <key>        SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>    SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                 Print stable machine-readable JSON
  --text                 Print human-readable text
  --format <format>      Output format: text or json
  -h, --help             display help for command
```

## Related reference

- [`smallforce social analytics linkedin`](/docs/cli/commands/social/analytics/linkedin): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads -->

# `smallforce ads`

Manage Meta, Google, and TikTok Ads through organization-scoped SmallForce resources

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce ads library`](/docs/cli/commands/ads/library): Research public Meta and LinkedIn advertising
- [`smallforce ads connections`](/docs/cli/commands/ads/connections): Connect and activate Meta Ads credentials
- [`smallforce ads accounts`](/docs/cli/commands/ads/accounts): Synchronize and inspect Meta Ads accounts
- [`smallforce ads campaigns`](/docs/cli/commands/ads/campaigns): Create, review, inspect, and manage Meta Ads campaigns
- [`smallforce ads businesses`](/docs/cli/commands/ads/businesses): Use smallforce ads businesses.
- [`smallforce ads ad-sets`](/docs/cli/commands/ads/ad-sets): Inspect, update, duplicate, and manage Meta Ads ad sets
- [`smallforce ads advertisements`](/docs/cli/commands/ads/advertisements): Inspect, update, duplicate, and manage Meta advertisements
- [`smallforce ads reports`](/docs/cli/commands/ads/reports): Run and retrieve asynchronous Meta Insights reports
- [`smallforce ads targeting`](/docs/cli/commands/ads/targeting): Search Meta targeting values and estimate audience reach
- [`smallforce ads predictable-reach`](/docs/cli/commands/ads/predictable-reach): Quote, reserve, inspect, and release Meta Reach & Frequency delivery
- [`smallforce ads lead-forms`](/docs/cli/commands/ads/lead-forms): List, create, inspect, archive, test, and read Meta Instant Forms
- [`smallforce ads leads`](/docs/cli/commands/ads/leads): Read captured Meta leads
- [`smallforce ads account-users`](/docs/cli/commands/ads/account-users): Manage Meta ad-account access
- [`smallforce ads page-users`](/docs/cli/commands/ads/page-users): Manage Facebook Page access
- [`smallforce ads videos`](/docs/cli/commands/ads/videos): Manage Meta Ads videos
- [`smallforce ads business-users`](/docs/cli/commands/ads/business-users): Discover Meta business users and system users
- [`smallforce ads instagram-posts`](/docs/cli/commands/ads/instagram-posts): Manage Meta Ads instagram-posts
- [`smallforce ads test-leads`](/docs/cli/commands/ads/test-leads): Manage Meta Ads test-leads
- [`smallforce ads catalogs`](/docs/cli/commands/ads/catalogs): Manage Meta Ads catalogs
- [`smallforce ads catalog-products`](/docs/cli/commands/ads/catalog-products): Manage Meta Ads catalog-products
- [`smallforce ads catalog-batches`](/docs/cli/commands/ads/catalog-batches): Manage Meta Ads catalog-batches
- [`smallforce ads catalog-feeds`](/docs/cli/commands/ads/catalog-feeds): Manage Meta Ads catalog-feeds
- [`smallforce ads catalog-uploads`](/docs/cli/commands/ads/catalog-uploads): Manage Meta Ads catalog-uploads
- [`smallforce ads catalog-sets`](/docs/cli/commands/ads/catalog-sets): Manage Meta Ads catalog-sets
- [`smallforce ads identities`](/docs/cli/commands/ads/identities): Manage Meta Ads identities
- [`smallforce ads applications`](/docs/cli/commands/ads/applications): Manage Meta Ads applications
- [`smallforce ads partnerships`](/docs/cli/commands/ads/partnerships): Manage Meta Ads partnerships
- [`smallforce ads insights`](/docs/cli/commands/ads/insights): Run synchronous Meta advertising insights queries
- [`smallforce ads creatives`](/docs/cli/commands/ads/creatives): Manage reusable Meta creatives, images, videos, and catalogs
- [`smallforce ads tracking-tags`](/docs/cli/commands/ads/tracking-tags): Manage Meta pixels, datasets, sharing, and statistics
- [`smallforce ads audiences`](/docs/cli/commands/ads/audiences): Manage Meta custom audiences
- [`smallforce ads conversions`](/docs/cli/commands/ads/conversions): Inspect conversion quality and send Meta conversion events
- [`smallforce ads messaging`](/docs/cli/commands/ads/messaging): Create Meta messaging, call, and WhatsApp advertisements
- [`smallforce ads google`](/docs/cli/commands/ads/google): Manage Google Ads through SmallForce-local, organization-scoped IDs
- [`smallforce ads tiktok`](/docs/cli/commands/ads/tiktok): Manage TikTok Ads through SmallForce-local, organization-scoped IDs

## Complete command help

```text
Usage: smallforce ads [options] [command]

Manage Meta, Google, and TikTok Ads through organization-scoped SmallForce resources

Options:
  -h, --help         display help for command

Commands:
  library            Research public Meta and LinkedIn advertising
  connections        Connect and activate Meta Ads credentials
  accounts           Synchronize and inspect Meta Ads accounts
  campaigns          Create, review, inspect, and manage Meta Ads campaigns
  businesses
  ad-sets            Inspect, update, duplicate, and manage Meta Ads ad sets
  advertisements     Inspect, update, duplicate, and manage Meta advertisements
  reports            Run and retrieve asynchronous Meta Insights reports
  targeting          Search Meta targeting values and estimate audience reach
  predictable-reach  Quote, reserve, inspect, and release Meta Reach & Frequency delivery
  lead-forms         List, create, inspect, archive, test, and read Meta Instant Forms
  leads              Read captured Meta leads
  account-users      Manage Meta ad-account access
  page-users         Manage Facebook Page access
  videos             Manage Meta Ads videos
  business-users     Discover Meta business users and system users
  instagram-posts    Manage Meta Ads instagram-posts
  test-leads         Manage Meta Ads test-leads
  catalogs           Manage Meta Ads catalogs
  catalog-products   Manage Meta Ads catalog-products
  catalog-batches    Manage Meta Ads catalog-batches
  catalog-feeds      Manage Meta Ads catalog-feeds
  catalog-uploads    Manage Meta Ads catalog-uploads
  catalog-sets       Manage Meta Ads catalog-sets
  identities         Manage Meta Ads identities
  applications       Manage Meta Ads applications
  partnerships       Manage Meta Ads partnerships
  insights           Run synchronous Meta advertising insights queries
  creatives          Manage reusable Meta creatives, images, videos, and catalogs
  tracking-tags      Manage Meta pixels, datasets, sharing, and statistics
  audiences          Manage Meta custom audiences
  conversions        Inspect conversion quality and send Meta conversion events
  messaging          Create Meta messaging, call, and WhatsApp advertisements
  google             Manage Google Ads through SmallForce-local, organization-scoped IDs
  tiktok             Manage TikTok Ads through SmallForce-local, organization-scoped IDs
  help [command]     display help for command
```

## Related reference

- [`smallforce`](/docs/cli/commands): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/library -->

# `smallforce ads library`

Research public Meta and LinkedIn advertising

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads library --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce ads library search`](/docs/cli/commands/ads/library/search): Search with an owned profile; LinkedIn also requires socialAccountId

## Complete command help

```text
Usage: smallforce ads library [options] [command]

Research public Meta and LinkedIn advertising

Options:
  -h, --help        display help for command

Commands:
  search [options]  Search with an owned profile; LinkedIn also requires socialAccountId
  help [command]    display help for command
```

## Related reference

- [`smallforce ads`](/docs/cli/commands/ads): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/library/search -->

# `smallforce ads library search`

Search with an owned profile; LinkedIn also requires socialAccountId

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads library search --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads library search [options]

Search with an owned profile; LinkedIn also requires socialAccountId

Options:
  --input <json>       Inline JSON request object
  --input-file <path>  JSON request file; use - to read from stdin
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  -h, --help           display help for command
```

## Related reference

- [`smallforce ads library`](/docs/cli/commands/ads/library): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/connections -->

# `smallforce ads connections`

Connect and activate Meta Ads credentials

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads connections --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce ads connections connect`](/docs/cli/commands/ads/connections/connect): Create or reuse a Meta Ads connection
- [`smallforce ads connections list`](/docs/cli/commands/ads/connections/list): List Meta Ads connections and activation state
- [`smallforce ads connections activate`](/docs/cli/commands/ads/connections/activate): Activate billing for one Meta Ads connection
- [`smallforce ads connections disconnect`](/docs/cli/commands/ads/connections/disconnect): Disconnect one Meta Ads credential

## Complete command help

```text
Usage: smallforce ads connections [options] [command]

Connect and activate Meta Ads credentials

Options:
  -h, --help                              display help for command

Commands:
  connect [options]                       Create or reuse a Meta Ads connection
  list [options]                          List Meta Ads connections and activation state
  activate [options] <socialAccountId>    Activate billing for one Meta Ads connection
  disconnect [options] <socialAccountId>  Disconnect one Meta Ads credential
  help [command]                          display help for command
```

## Related reference

- [`smallforce ads`](/docs/cli/commands/ads): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/connections/connect -->

# `smallforce ads connections connect`

Create or reuse a Meta Ads connection

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads connections connect --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads connections connect [options]

Create or reuse a Meta Ads connection

Options:
  --profile <profileId>       Social profile id from social profiles list
  --via <platform>            Parent platform: facebook or instagram (default: "facebook")
  --provider-account <actId>  Limit provider sync to one act_<digits> account; repeatable (default:
                              [])
  --redirect-url <url>        Browser destination after authorization
  --login-mode <mode>         Meta authorization: classic or business
  --page-id <id>              Granted Meta Page ID for business login
  --force                     Start a fresh authorization
  --headless                  Request a headless provider authorization flow
  --api-key <key>             SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>         SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                      Print stable machine-readable JSON
  --text                      Print human-readable text
  --format <format>           Output format: text or json
  -h, --help                  display help for command
```

## Related reference

- [`smallforce ads connections`](/docs/cli/commands/ads/connections): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/connections/list -->

# `smallforce ads connections list`

List Meta Ads connections and activation state

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads connections list --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads connections list [options]

List Meta Ads connections and activation state

Options:
  --profile <profileId>  Filter by one social profile
  --include-deleted      Include disconnected connections
  --api-key <key>        SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>    SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                 Print stable machine-readable JSON
  --text                 Print human-readable text
  --format <format>      Output format: text or json
  -h, --help             display help for command
```

## Related reference

- [`smallforce ads connections`](/docs/cli/commands/ads/connections): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/connections/activate -->

# `smallforce ads connections activate`

Activate billing for one Meta Ads connection

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads connections activate --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads connections activate [options] <socialAccountId>

Activate billing for one Meta Ads connection

Arguments:
  socialAccountId      Local connection id

Options:
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  -h, --help           display help for command
```

## Related reference

- [`smallforce ads connections`](/docs/cli/commands/ads/connections): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/connections/disconnect -->

# `smallforce ads connections disconnect`

Disconnect one Meta Ads credential

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads connections disconnect --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads connections disconnect [options] <socialAccountId>

Disconnect one Meta Ads credential

Arguments:
  socialAccountId      Local connection id

Options:
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  -h, --help           display help for command
```

## Related reference

- [`smallforce ads connections`](/docs/cli/commands/ads/connections): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/accounts -->

# `smallforce ads accounts`

Synchronize and inspect Meta Ads accounts

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads accounts --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce ads accounts list`](/docs/cli/commands/ads/accounts/list): List local Meta Ads account IDs
- [`smallforce ads accounts sync`](/docs/cli/commands/ads/accounts/sync): Synchronize provider accounts for one Meta Ads connection
- [`smallforce ads accounts create`](/docs/cli/commands/ads/accounts/create): Create a Meta ad account in your business portfolio
- [`smallforce ads accounts live`](/docs/cli/commands/ads/accounts/live): Get ad account live entities
- [`smallforce ads accounts activity`](/docs/cli/commands/ads/accounts/activity): Read the Meta ad-account activity log
- [`smallforce ads accounts studies`](/docs/cli/commands/ads/accounts/studies): List Meta ad studies
- [`smallforce ads accounts businesses`](/docs/cli/commands/ads/accounts/businesses): List Meta businesses visible to the connection
- [`smallforce ads accounts labels`](/docs/cli/commands/ads/accounts/labels): List Meta ad-account labels
- [`smallforce ads accounts high-demand-periods`](/docs/cli/commands/ads/accounts/high-demand-periods): List high-demand periods for a campaign or ad set
- [`smallforce ads accounts create-high-demand-period`](/docs/cli/commands/ads/accounts/create-high-demand-period): Create a Meta high-demand period
- [`smallforce ads accounts value-rule-sets`](/docs/cli/commands/ads/accounts/value-rule-sets): List Meta value rule sets
- [`smallforce ads accounts create-value-rule-set`](/docs/cli/commands/ads/accounts/create-value-rule-set): Create a Meta value rule set
- [`smallforce ads accounts get-value-rule-set`](/docs/cli/commands/ads/accounts/get-value-rule-set): Read a Meta value rule set
- [`smallforce ads accounts update-value-rule-set`](/docs/cli/commands/ads/accounts/update-value-rule-set): Update a Meta value rule set
- [`smallforce ads accounts delete-value-rule-set`](/docs/cli/commands/ads/accounts/delete-value-rule-set): Delete a Meta value rule set
- [`smallforce ads accounts finance`](/docs/cli/commands/ads/accounts/finance): Read Meta ad-account finance details
- [`smallforce ads accounts update`](/docs/cli/commands/ads/accounts/update): Update Meta ad-account defaults
- [`smallforce ads accounts dsa-defaults`](/docs/cli/commands/ads/accounts/dsa-defaults): Read Meta DSA beneficiary and payor defaults
- [`smallforce ads accounts dsa-recommendations`](/docs/cli/commands/ads/accounts/dsa-recommendations): Read Meta DSA recommendations
- [`smallforce ads accounts custom-conversions`](/docs/cli/commands/ads/accounts/custom-conversions): List Meta custom conversions
- [`smallforce ads accounts create-custom-conversion`](/docs/cli/commands/ads/accounts/create-custom-conversion): Create a Meta custom conversion

## Complete command help

```text
Usage: smallforce ads accounts [options] [command]

Synchronize and inspect Meta Ads accounts

Options:
  -h, --help                                      display help for command

Commands:
  list [options]                                  List local Meta Ads account IDs
  sync [options] <socialAccountId>                Synchronize provider accounts for one Meta Ads
                                                  connection
  create [options]                                Create a Meta ad account in your business
                                                  portfolio
  live [options]                                  Get ad account live entities
  activity [options]                              Read the Meta ad-account activity log
  studies [options]                               List Meta ad studies
  businesses [options]                            List Meta businesses visible to the connection
  labels [options]                                List Meta ad-account labels
  high-demand-periods [options] <targetId>        List high-demand periods for a campaign or ad set
  create-high-demand-period [options] <targetId>  Create a Meta high-demand period
  value-rule-sets [options]                       List Meta value rule sets
  create-value-rule-set [options]                 Create a Meta value rule set
  get-value-rule-set [options] <targetId>         Read a Meta value rule set
  update-value-rule-set [options] <targetId>      Update a Meta value rule set
  delete-value-rule-set [options] <targetId>      Delete a Meta value rule set
  finance [options]                               Read Meta ad-account finance details
  update [options]                                Update Meta ad-account defaults
  dsa-defaults [options]                          Read Meta DSA beneficiary and payor defaults
  dsa-recommendations [options]                   Read Meta DSA recommendations
  custom-conversions [options]                    List Meta custom conversions
  create-custom-conversion [options]              Create a Meta custom conversion
  help [command]                                  display help for command
```

## Related reference

- [`smallforce ads`](/docs/cli/commands/ads): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/accounts/list -->

# `smallforce ads accounts list`

List local Meta Ads account IDs

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads accounts list --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads accounts list [options]

List local Meta Ads account IDs

Options:
  --connection <socialAccountId>  Filter by one Meta Ads connection
  --api-key <key>                 SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>             SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                          Print stable machine-readable JSON
  --text                          Print human-readable text
  --format <format>               Output format: text or json
  -h, --help                      display help for command
```

## Related reference

- [`smallforce ads accounts`](/docs/cli/commands/ads/accounts): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/accounts/sync -->

# `smallforce ads accounts sync`

Synchronize provider accounts for one Meta Ads connection

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads accounts sync --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads accounts sync [options] <socialAccountId>

Synchronize provider accounts for one Meta Ads connection

Arguments:
  socialAccountId      Local connection id

Options:
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  -h, --help           display help for command
```

## Related reference

- [`smallforce ads accounts`](/docs/cli/commands/ads/accounts): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/accounts/create -->

# `smallforce ads accounts create`

Create a Meta ad account in your business portfolio

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads accounts create --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads accounts create [options]

Create a Meta ad account in your business portfolio

Options:
  --input <json>       Inline JSON request object
  --input-file <path>  JSON request file; use - to read from stdin
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  -h, --help           display help for command
```

## Related reference

- [`smallforce ads accounts`](/docs/cli/commands/ads/accounts): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/accounts/live -->

# `smallforce ads accounts live`

Get ad account live entities

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads accounts live --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads accounts live [options]

Get ad account live entities

Options:
  --account <adAccountId>  Local id from ads accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads accounts`](/docs/cli/commands/ads/accounts): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/accounts/activity -->

# `smallforce ads accounts activity`

Read the Meta ad-account activity log

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads accounts activity --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads accounts activity [options]

Read the Meta ad-account activity log

Options:
  --account <adAccountId>  Local id from ads accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads accounts`](/docs/cli/commands/ads/accounts): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/accounts/studies -->

# `smallforce ads accounts studies`

List Meta ad studies

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads accounts studies --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads accounts studies [options]

List Meta ad studies

Options:
  --account <adAccountId>  Local id from ads accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads accounts`](/docs/cli/commands/ads/accounts): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/accounts/businesses -->

# `smallforce ads accounts businesses`

List Meta businesses visible to the connection

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads accounts businesses --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads accounts businesses [options]

List Meta businesses visible to the connection

Options:
  --account <adAccountId>  Local id from ads accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads accounts`](/docs/cli/commands/ads/accounts): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/accounts/labels -->

# `smallforce ads accounts labels`

List Meta ad-account labels

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads accounts labels --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads accounts labels [options]

List Meta ad-account labels

Options:
  --account <adAccountId>  Local id from ads accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads accounts`](/docs/cli/commands/ads/accounts): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/accounts/high-demand-periods -->

# `smallforce ads accounts high-demand-periods`

List high-demand periods for a campaign or ad set

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads accounts high-demand-periods --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads accounts high-demand-periods [options] <targetId>

List high-demand periods for a campaign or ad set

Arguments:
  targetId                 SmallForce-local campaign or ad-set id; raw Meta ids are rejected

Options:
  --account <adAccountId>  Local id from ads accounts list
  --target-kind <kind>     campaign or ad_set
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads accounts`](/docs/cli/commands/ads/accounts): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/accounts/create-high-demand-period -->

# `smallforce ads accounts create-high-demand-period`

Create a Meta high-demand period

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads accounts create-high-demand-period --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads accounts create-high-demand-period [options] <targetId>

Create a Meta high-demand period

Arguments:
  targetId                 SmallForce-local campaign or ad-set id; raw Meta ids are rejected

Options:
  --account <adAccountId>  Local id from ads accounts list
  --target-kind <kind>     campaign or ad_set
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads accounts`](/docs/cli/commands/ads/accounts): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/accounts/value-rule-sets -->

# `smallforce ads accounts value-rule-sets`

List Meta value rule sets

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads accounts value-rule-sets --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads accounts value-rule-sets [options]

List Meta value rule sets

Options:
  --account <adAccountId>  Local id from ads accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads accounts`](/docs/cli/commands/ads/accounts): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/accounts/create-value-rule-set -->

# `smallforce ads accounts create-value-rule-set`

Create a Meta value rule set

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads accounts create-value-rule-set --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads accounts create-value-rule-set [options]

Create a Meta value rule set

Options:
  --account <adAccountId>  Local id from ads accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads accounts`](/docs/cli/commands/ads/accounts): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/accounts/get-value-rule-set -->

# `smallforce ads accounts get-value-rule-set`

Read a Meta value rule set

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads accounts get-value-rule-set --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads accounts get-value-rule-set [options] <targetId>

Read a Meta value rule set

Arguments:
  targetId                 SmallForce-local value-rule-set id; raw Meta ids are rejected

Options:
  --account <adAccountId>  Local id from ads accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads accounts`](/docs/cli/commands/ads/accounts): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/accounts/update-value-rule-set -->

# `smallforce ads accounts update-value-rule-set`

Update a Meta value rule set

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads accounts update-value-rule-set --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads accounts update-value-rule-set [options] <targetId>

Update a Meta value rule set

Arguments:
  targetId                 SmallForce-local value-rule-set id; raw Meta ids are rejected

Options:
  --account <adAccountId>  Local id from ads accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads accounts`](/docs/cli/commands/ads/accounts): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/accounts/delete-value-rule-set -->

# `smallforce ads accounts delete-value-rule-set`

Delete a Meta value rule set

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads accounts delete-value-rule-set --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads accounts delete-value-rule-set [options] <targetId>

Delete a Meta value rule set

Arguments:
  targetId                 SmallForce-local value-rule-set id; raw Meta ids are rejected

Options:
  --account <adAccountId>  Local id from ads accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads accounts`](/docs/cli/commands/ads/accounts): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/accounts/finance -->

# `smallforce ads accounts finance`

Read Meta ad-account finance details

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads accounts finance --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads accounts finance [options]

Read Meta ad-account finance details

Options:
  --account <adAccountId>  Local id from ads accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads accounts`](/docs/cli/commands/ads/accounts): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/accounts/update -->

# `smallforce ads accounts update`

Update Meta ad-account defaults

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads accounts update --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads accounts update [options]

Update Meta ad-account defaults

Options:
  --account <adAccountId>  Local id from ads accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads accounts`](/docs/cli/commands/ads/accounts): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/accounts/dsa-defaults -->

# `smallforce ads accounts dsa-defaults`

Read Meta DSA beneficiary and payor defaults

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads accounts dsa-defaults --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads accounts dsa-defaults [options]

Read Meta DSA beneficiary and payor defaults

Options:
  --account <adAccountId>  Local id from ads accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads accounts`](/docs/cli/commands/ads/accounts): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/accounts/dsa-recommendations -->

# `smallforce ads accounts dsa-recommendations`

Read Meta DSA recommendations

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads accounts dsa-recommendations --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads accounts dsa-recommendations [options]

Read Meta DSA recommendations

Options:
  --account <adAccountId>  Local id from ads accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads accounts`](/docs/cli/commands/ads/accounts): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/accounts/custom-conversions -->

# `smallforce ads accounts custom-conversions`

List Meta custom conversions

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads accounts custom-conversions --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads accounts custom-conversions [options]

List Meta custom conversions

Options:
  --account <adAccountId>  Local id from ads accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads accounts`](/docs/cli/commands/ads/accounts): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/accounts/create-custom-conversion -->

# `smallforce ads accounts create-custom-conversion`

Create a Meta custom conversion

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads accounts create-custom-conversion --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads accounts create-custom-conversion [options]

Create a Meta custom conversion

Options:
  --account <adAccountId>  Local id from ads accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads accounts`](/docs/cli/commands/ads/accounts): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/campaigns -->

# `smallforce ads campaigns`

Create, review, inspect, and manage Meta Ads campaigns

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads campaigns --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce ads campaigns list`](/docs/cli/commands/ads/campaigns/list): List Meta Ads campaigns
- [`smallforce ads campaigns tree`](/docs/cli/commands/ads/campaigns/tree): Read campaigns with nested ad sets and advertisements
- [`smallforce ads campaigns analytics`](/docs/cli/commands/ads/campaigns/analytics): Get summary, daily, and optional breakdown analytics
- [`smallforce ads campaigns preflight`](/docs/cli/commands/ads/campaigns/preflight): Check whether a paused Meta campaign is ready to activate
- [`smallforce ads campaigns validate`](/docs/cli/commands/ads/campaigns/validate): Validate a complete Meta campaign draft without creating it
- [`smallforce ads campaigns preview`](/docs/cli/commands/ads/campaigns/preview): Generate safe Meta placement previews for a campaign draft
- [`smallforce ads campaigns create`](/docs/cli/commands/ads/campaigns/create): Create a complete Meta campaign, ad set, and advertisement
- [`smallforce ads campaigns update`](/docs/cli/commands/ads/campaigns/update): Update Meta campaign name, CBO budget, bid strategy, or spend cap
- [`smallforce ads campaigns status`](/docs/cli/commands/ads/campaigns/status): Activate or pause one Meta campaign
- [`smallforce ads campaigns details`](/docs/cli/commands/ads/campaigns/details): Get live campaign details
- [`smallforce ads campaigns create-empty`](/docs/cli/commands/ads/campaigns/create-empty): Create an empty Meta campaign
- [`smallforce ads campaigns delete`](/docs/cli/commands/ads/campaigns/delete): Delete a Meta campaign
- [`smallforce ads campaigns bulk-status`](/docs/cli/commands/ads/campaigns/bulk-status): Activate or pause several Meta campaigns
- [`smallforce ads campaigns duplicate`](/docs/cli/commands/ads/campaigns/duplicate): Duplicate a Meta campaign hierarchy
- [`smallforce ads campaigns timeline`](/docs/cli/commands/ads/campaigns/timeline): Read the Meta Ads performance timeline

## Complete command help

```text
Usage: smallforce ads campaigns [options] [command]

Create, review, inspect, and manage Meta Ads campaigns

Options:
  -h, --help                              display help for command

Commands:
  list [options]                          List Meta Ads campaigns
  tree [options]                          Read campaigns with nested ad sets and advertisements
  analytics [options] <campaignId>        Get summary, daily, and optional breakdown analytics
  preflight [options] <campaignId>        Check whether a paused Meta campaign is ready to activate
  validate [options]                      Validate a complete Meta campaign draft without creating
                                          it
  preview [options]                       Generate safe Meta placement previews for a campaign draft
  create [options]                        Create a complete Meta campaign, ad set, and advertisement
  update [options] <campaignId>           Update Meta campaign name, CBO budget, bid strategy, or
                                          spend cap
  status [options] <campaignId> <status>  Activate or pause one Meta campaign
  details [options] <targetId>            Get live campaign details
  create-empty [options]                  Create an empty Meta campaign
  delete [options] <targetId>             Delete a Meta campaign
  bulk-status [options]                   Activate or pause several Meta campaigns
  duplicate [options] <targetId>          Duplicate a Meta campaign hierarchy
  timeline [options]                      Read the Meta Ads performance timeline
  help [command]                          display help for command
```

## Related reference

- [`smallforce ads`](/docs/cli/commands/ads): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/campaigns/list -->

# `smallforce ads campaigns list`

List Meta Ads campaigns

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads campaigns list --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads campaigns list [options]

List Meta Ads campaigns

Options:
  --account <adAccountId>  Local id from ads accounts list
  --platform <platform>    facebook or instagram
  --status <status>        Campaign status filter
  --source <source>        all or zernio (default: "all")
  --from <date>            Inclusive YYYY-MM-DD start date
  --to <date>              Inclusive YYYY-MM-DD end date
  --page <n>               Page number, starting at 1
  --limit <n>              Campaigns per page, 1 to 100
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads campaigns`](/docs/cli/commands/ads/campaigns): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/campaigns/tree -->

# `smallforce ads campaigns tree`

Read campaigns with nested ad sets and advertisements

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads campaigns tree --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads campaigns tree [options]

Read campaigns with nested ad sets and advertisements

Options:
  --account <adAccountId>  Local id from ads accounts list
  --platform <platform>    facebook or instagram
  --status <status>        Campaign status filter
  --source <source>        all or zernio (default: "all")
  --from <date>            Inclusive YYYY-MM-DD start date
  --to <date>              Inclusive YYYY-MM-DD end date
  --page <n>               Page number, starting at 1
  --limit <n>              Campaigns per page, 1 to 100
  --campaign <campaignId>  Limit to one local campaign id
  --include-daily          Include daily metric rows
  --daily-level <level>    campaign, adset, or ad
  --sort <sort>            newest, oldest, spend_desc, or spend_asc
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads campaigns`](/docs/cli/commands/ads/campaigns): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/campaigns/analytics -->

# `smallforce ads campaigns analytics`

Get summary, daily, and optional breakdown analytics

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads campaigns analytics --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads campaigns analytics [options] <campaignId>

Get summary, daily, and optional breakdown analytics

Arguments:
  campaignId               Local campaign id from campaigns list

Options:
  --account <adAccountId>  Local id from ads accounts list
  --platform <platform>    facebook or instagram
  --from <date>            Inclusive YYYY-MM-DD start date
  --to <date>              Inclusive YYYY-MM-DD end date
  --breakdown <dimension>  age, gender, country, publisher_platform, device_platform, or region;
                           repeatable (default: [])
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads campaigns`](/docs/cli/commands/ads/campaigns): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/campaigns/preflight -->

# `smallforce ads campaigns preflight`

Check whether a paused Meta campaign is ready to activate

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads campaigns preflight --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads campaigns preflight [options] <campaignId>

Check whether a paused Meta campaign is ready to activate

Arguments:
  campaignId               Local campaign id from campaigns list

Options:
  --account <adAccountId>  Local id from ads accounts list
  --platform <platform>    facebook or instagram
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads campaigns`](/docs/cli/commands/ads/campaigns): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/campaigns/validate -->

# `smallforce ads campaigns validate`

Validate a complete Meta campaign draft without creating it

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads campaigns validate --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads campaigns validate [options]

Validate a complete Meta campaign draft without creating it

Options:
  --input <json>       Inline JSON request object
  --input-file <path>  JSON request file; use - to read from stdin
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  -h, --help           display help for command
```

## Related reference

- [`smallforce ads campaigns`](/docs/cli/commands/ads/campaigns): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/campaigns/preview -->

# `smallforce ads campaigns preview`

Generate safe Meta placement previews for a campaign draft

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads campaigns preview --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads campaigns preview [options]

Generate safe Meta placement previews for a campaign draft

Options:
  --input <json>       Inline JSON request object
  --input-file <path>  JSON request file; use - to read from stdin
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  -h, --help           display help for command
```

## Related reference

- [`smallforce ads campaigns`](/docs/cli/commands/ads/campaigns): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/campaigns/create -->

# `smallforce ads campaigns create`

Create a complete Meta campaign, ad set, and advertisement

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads campaigns create --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads campaigns create [options]

Create a complete Meta campaign, ad set, and advertisement

Options:
  --input <json>       Inline JSON request object
  --input-file <path>  JSON request file; use - to read from stdin
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  -h, --help           display help for command
```

## Related reference

- [`smallforce ads campaigns`](/docs/cli/commands/ads/campaigns): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/campaigns/update -->

# `smallforce ads campaigns update`

Update Meta campaign name, CBO budget, bid strategy, or spend cap

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads campaigns update --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads campaigns update [options] <campaignId>

Update Meta campaign name, CBO budget, bid strategy, or spend cap

Arguments:
  campaignId               Local campaign id from campaigns list

Options:
  --account <adAccountId>  Local id from ads accounts list
  --platform <platform>    facebook or instagram
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads campaigns`](/docs/cli/commands/ads/campaigns): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/campaigns/status -->

# `smallforce ads campaigns status`

Activate or pause one Meta campaign

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads campaigns status --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads campaigns status [options] <campaignId> <status>

Activate or pause one Meta campaign

Arguments:
  campaignId               Local campaign id from campaigns list
  status                   active or paused

Options:
  --account <adAccountId>  Local id from ads accounts list
  --platform <platform>    facebook or instagram
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads campaigns`](/docs/cli/commands/ads/campaigns): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/campaigns/details -->

# `smallforce ads campaigns details`

Get live campaign details

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads campaigns details --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads campaigns details [options] <targetId>

Get live campaign details

Arguments:
  targetId                 SmallForce-local campaign id; raw Meta ids are rejected

Options:
  --account <adAccountId>  Local id from ads accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads campaigns`](/docs/cli/commands/ads/campaigns): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/campaigns/create-empty -->

# `smallforce ads campaigns create-empty`

Create an empty Meta campaign

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads campaigns create-empty --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads campaigns create-empty [options]

Create an empty Meta campaign

Options:
  --account <adAccountId>  Local id from ads accounts list
  --idempotency-key <key>  Idempotency key forwarded for provider mutations
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads campaigns`](/docs/cli/commands/ads/campaigns): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/campaigns/delete -->

# `smallforce ads campaigns delete`

Delete a Meta campaign

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads campaigns delete --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads campaigns delete [options] <targetId>

Delete a Meta campaign

Arguments:
  targetId                 SmallForce-local campaign id; raw Meta ids are rejected

Options:
  --account <adAccountId>  Local id from ads accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads campaigns`](/docs/cli/commands/ads/campaigns): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/campaigns/bulk-status -->

# `smallforce ads campaigns bulk-status`

Activate or pause several Meta campaigns

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads campaigns bulk-status --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads campaigns bulk-status [options]

Activate or pause several Meta campaigns

Options:
  --account <adAccountId>  Local id from ads accounts list
  --campaign <campaignId>  Local campaign id; repeat for multiple campaigns (default: [])
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads campaigns`](/docs/cli/commands/ads/campaigns): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/campaigns/duplicate -->

# `smallforce ads campaigns duplicate`

Duplicate a Meta campaign hierarchy

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads campaigns duplicate --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads campaigns duplicate [options] <targetId>

Duplicate a Meta campaign hierarchy

Arguments:
  targetId                 SmallForce-local campaign id; raw Meta ids are rejected

Options:
  --account <adAccountId>  Local id from ads accounts list
  --idempotency-key <key>  Idempotency key forwarded for provider mutations
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads campaigns`](/docs/cli/commands/ads/campaigns): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/campaigns/timeline -->

# `smallforce ads campaigns timeline`

Read the Meta Ads performance timeline

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads campaigns timeline --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads campaigns timeline [options]

Read the Meta Ads performance timeline

Options:
  --account <adAccountId>  Local id from ads accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads campaigns`](/docs/cli/commands/ads/campaigns): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/businesses -->

# `smallforce ads businesses`

Reference for the smallforce ads businesses command.

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads businesses --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce ads businesses list`](/docs/cli/commands/ads/businesses/list): List portfolios before creating your first Meta ad account

## Complete command help

```text
Usage: smallforce ads businesses [options] [command]

Options:
  -h, --help      display help for command

Commands:
  list [options]  List portfolios before creating your first Meta ad account
  help [command]  display help for command
```

## Related reference

- [`smallforce ads`](/docs/cli/commands/ads): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/businesses/list -->

# `smallforce ads businesses list`

List portfolios before creating your first Meta ad account

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads businesses list --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads businesses list [options]

List portfolios before creating your first Meta ad account

Options:
  --connection <uuid>  Owned Meta Ads connection UUID
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  -h, --help           display help for command
```

## Related reference

- [`smallforce ads businesses`](/docs/cli/commands/ads/businesses): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/ad-sets -->

# `smallforce ads ad-sets`

Inspect, update, duplicate, and manage Meta Ads ad sets

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads ad-sets --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce ads ad-sets get`](/docs/cli/commands/ads/ad-sets/get): Get one ad set with live schedule and learning state
- [`smallforce ads ad-sets update`](/docs/cli/commands/ads/ad-sets/update): Update a Meta ad set's delivery, budget, bidding, or customer lifecycle
- [`smallforce ads ad-sets list`](/docs/cli/commands/ads/ad-sets/list): List Meta ad sets including empty sets
- [`smallforce ads ad-sets delete`](/docs/cli/commands/ads/ad-sets/delete): Delete a Meta ad set and its ads
- [`smallforce ads ad-sets duplicate`](/docs/cli/commands/ads/ad-sets/duplicate): Duplicate a Meta ad set
- [`smallforce ads ad-sets status`](/docs/cli/commands/ads/ad-sets/status): Update a Meta ad-set status

## Complete command help

```text
Usage: smallforce ads ad-sets [options] [command]

Inspect, update, duplicate, and manage Meta Ads ad sets

Options:
  -h, --help                      display help for command

Commands:
  get [options] <adSetId>         Get one ad set with live schedule and learning state
  update [options] <adSetId>      Update a Meta ad set's delivery, budget, bidding, or customer
                                  lifecycle
  list [options]                  List Meta ad sets including empty sets
  delete [options] <targetId>     Delete a Meta ad set and its ads
  duplicate [options] <targetId>  Duplicate a Meta ad set
  status [options] <targetId>     Update a Meta ad-set status
  help [command]                  display help for command
```

## Related reference

- [`smallforce ads`](/docs/cli/commands/ads): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/ad-sets/get -->

# `smallforce ads ad-sets get`

Get one ad set with live schedule and learning state

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads ad-sets get --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads ad-sets get [options] <adSetId>

Get one ad set with live schedule and learning state

Arguments:
  adSetId                  Local ad-set id from campaigns tree

Options:
  --account <adAccountId>  Local id from ads accounts list
  --campaign <campaignId>  Local campaign id from campaigns tree
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads ad-sets`](/docs/cli/commands/ads/ad-sets): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/ad-sets/update -->

# `smallforce ads ad-sets update`

Update a Meta ad set's delivery, budget, bidding, or customer lifecycle

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads ad-sets update --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads ad-sets update [options] <adSetId>

Update a Meta ad set's delivery, budget, bidding, or customer lifecycle

Arguments:
  adSetId                  Local ad-set id from campaigns tree

Options:
  --account <adAccountId>  Local id from ads accounts list
  --campaign <campaignId>  Local campaign id from campaigns tree
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads ad-sets`](/docs/cli/commands/ads/ad-sets): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/ad-sets/list -->

# `smallforce ads ad-sets list`

List Meta ad sets including empty sets

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads ad-sets list --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads ad-sets list [options]

List Meta ad sets including empty sets

Options:
  --account <adAccountId>  Local id from ads accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads ad-sets`](/docs/cli/commands/ads/ad-sets): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/ad-sets/delete -->

# `smallforce ads ad-sets delete`

Delete a Meta ad set and its ads

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads ad-sets delete --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads ad-sets delete [options] <targetId>

Delete a Meta ad set and its ads

Arguments:
  targetId                 SmallForce-local ad-set id; raw Meta ids are rejected

Options:
  --account <adAccountId>  Local id from ads accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads ad-sets`](/docs/cli/commands/ads/ad-sets): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/ad-sets/duplicate -->

# `smallforce ads ad-sets duplicate`

Duplicate a Meta ad set

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads ad-sets duplicate --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads ad-sets duplicate [options] <targetId>

Duplicate a Meta ad set

Arguments:
  targetId                 SmallForce-local ad-set id; raw Meta ids are rejected

Options:
  --account <adAccountId>  Local id from ads accounts list
  --idempotency-key <key>  Idempotency key forwarded for provider mutations
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads ad-sets`](/docs/cli/commands/ads/ad-sets): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/ad-sets/status -->

# `smallforce ads ad-sets status`

Update a Meta ad-set status

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads ad-sets status --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads ad-sets status [options] <targetId>

Update a Meta ad-set status

Arguments:
  targetId                 SmallForce-local ad-set id; raw Meta ids are rejected

Options:
  --account <adAccountId>  Local id from ads accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads ad-sets`](/docs/cli/commands/ads/ad-sets): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/advertisements -->

# `smallforce ads advertisements`

Inspect, update, duplicate, and manage Meta advertisements

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads advertisements --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce ads advertisements update`](/docs/cli/commands/ads/advertisements/update): Update an ad's name, status, or image creative
- [`smallforce ads advertisements list`](/docs/cli/commands/ads/advertisements/list): List individual Meta advertisements
- [`smallforce ads advertisements duplicate`](/docs/cli/commands/ads/advertisements/duplicate): Duplicate a Meta advertisement
- [`smallforce ads advertisements delete`](/docs/cli/commands/ads/advertisements/delete): Delete a Meta advertisement
- [`smallforce ads advertisements status`](/docs/cli/commands/ads/advertisements/status): Update a Meta advertisement status
- [`smallforce ads advertisements boost-post`](/docs/cli/commands/ads/advertisements/boost-post): Boost a SmallForce social post with Meta Ads
- [`smallforce ads advertisements analytics`](/docs/cli/commands/ads/advertisements/analytics): Read analytics for one Meta advertisement
- [`smallforce ads advertisements previews`](/docs/cli/commands/ads/advertisements/previews): Read placement previews for one Meta advertisement
- [`smallforce ads advertisements media`](/docs/cli/commands/ads/advertisements/media): Read fresh signed media URLs for one Meta advertisement
- [`smallforce ads advertisements tracking-tags`](/docs/cli/commands/ads/advertisements/tracking-tags): Read tracking parameters for a Meta advertisement
- [`smallforce ads advertisements update-tracking-tags`](/docs/cli/commands/ads/advertisements/update-tracking-tags): Update tracking parameters for a Meta advertisement
- [`smallforce ads advertisements comments`](/docs/cli/commands/ads/advertisements/comments): Read comments attached to a Meta advertisement

## Complete command help

```text
Usage: smallforce ads advertisements [options] [command]

Inspect, update, duplicate, and manage Meta advertisements

Options:
  -h, --help                                 display help for command

Commands:
  update [options] <adId>                    Update an ad's name, status, or image creative
  list [options]                             List individual Meta advertisements
  duplicate [options] <targetId>             Duplicate a Meta advertisement
  delete [options] <targetId>                Delete a Meta advertisement
  status [options] <targetId>                Update a Meta advertisement status
  boost-post [options] <targetId>            Boost a SmallForce social post with Meta Ads
  analytics [options] <targetId>             Read analytics for one Meta advertisement
  previews [options] <targetId>              Read placement previews for one Meta advertisement
  media [options] <targetId>                 Read fresh signed media URLs for one Meta advertisement
  tracking-tags [options] <targetId>         Read tracking parameters for a Meta advertisement
  update-tracking-tags [options] <targetId>  Update tracking parameters for a Meta advertisement
  comments [options] <targetId>              Read comments attached to a Meta advertisement
  help [command]                             display help for command
```

## Related reference

- [`smallforce ads`](/docs/cli/commands/ads): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/advertisements/update -->

# `smallforce ads advertisements update`

Update an ad's name, status, or image creative

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads advertisements update --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads advertisements update [options] <adId>

Update an ad's name, status, or image creative

Arguments:
  adId                     Local advertisement id from campaigns tree

Options:
  --account <adAccountId>  Local id from ads accounts list
  --campaign <campaignId>  Local campaign id
  --ad-set <adSetId>       Local ad-set id
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads advertisements`](/docs/cli/commands/ads/advertisements): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/advertisements/list -->

# `smallforce ads advertisements list`

List individual Meta advertisements

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads advertisements list --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads advertisements list [options]

List individual Meta advertisements

Options:
  --account <adAccountId>  Local id from ads accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads advertisements`](/docs/cli/commands/ads/advertisements): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/advertisements/duplicate -->

# `smallforce ads advertisements duplicate`

Duplicate a Meta advertisement

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads advertisements duplicate --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads advertisements duplicate [options] <targetId>

Duplicate a Meta advertisement

Arguments:
  targetId                 SmallForce-local advertisement id; raw Meta ids are rejected

Options:
  --account <adAccountId>  Local id from ads accounts list
  --idempotency-key <key>  Idempotency key forwarded for provider mutations
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads advertisements`](/docs/cli/commands/ads/advertisements): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/advertisements/delete -->

# `smallforce ads advertisements delete`

Delete a Meta advertisement

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads advertisements delete --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads advertisements delete [options] <targetId>

Delete a Meta advertisement

Arguments:
  targetId                 SmallForce-local advertisement id; raw Meta ids are rejected

Options:
  --account <adAccountId>  Local id from ads accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads advertisements`](/docs/cli/commands/ads/advertisements): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/advertisements/status -->

# `smallforce ads advertisements status`

Update a Meta advertisement status

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads advertisements status --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads advertisements status [options] <targetId>

Update a Meta advertisement status

Arguments:
  targetId                 SmallForce-local advertisement id; raw Meta ids are rejected

Options:
  --account <adAccountId>  Local id from ads accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads advertisements`](/docs/cli/commands/ads/advertisements): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/advertisements/boost-post -->

# `smallforce ads advertisements boost-post`

Boost a SmallForce social post with Meta Ads

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads advertisements boost-post --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads advertisements boost-post [options] <targetId>

Boost a SmallForce social post with Meta Ads

Arguments:
  targetId                 SmallForce-local social-post id; raw Meta ids are rejected

Options:
  --account <adAccountId>  Local id from ads accounts list
  --idempotency-key <key>  Idempotency key forwarded for provider mutations
  --target-kind <kind>     social_post (default) or instagram_post from instagram-posts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads advertisements`](/docs/cli/commands/ads/advertisements): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/advertisements/analytics -->

# `smallforce ads advertisements analytics`

Read analytics for one Meta advertisement

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads advertisements analytics --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads advertisements analytics [options] <targetId>

Read analytics for one Meta advertisement

Arguments:
  targetId                 SmallForce-local advertisement id; raw Meta ids are rejected

Options:
  --account <adAccountId>  Local id from ads accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads advertisements`](/docs/cli/commands/ads/advertisements): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/advertisements/previews -->

# `smallforce ads advertisements previews`

Read placement previews for one Meta advertisement

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads advertisements previews --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads advertisements previews [options] <targetId>

Read placement previews for one Meta advertisement

Arguments:
  targetId                 SmallForce-local advertisement id; raw Meta ids are rejected

Options:
  --account <adAccountId>  Local id from ads accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads advertisements`](/docs/cli/commands/ads/advertisements): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/advertisements/media -->

# `smallforce ads advertisements media`

Read fresh signed media URLs for one Meta advertisement

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads advertisements media --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads advertisements media [options] <targetId>

Read fresh signed media URLs for one Meta advertisement

Arguments:
  targetId                 SmallForce-local advertisement id; raw Meta ids are rejected

Options:
  --account <adAccountId>  Local id from ads accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads advertisements`](/docs/cli/commands/ads/advertisements): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/advertisements/tracking-tags -->

# `smallforce ads advertisements tracking-tags`

Read tracking parameters for a Meta advertisement

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads advertisements tracking-tags --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads advertisements tracking-tags [options] <targetId>

Read tracking parameters for a Meta advertisement

Arguments:
  targetId                 SmallForce-local advertisement id; raw Meta ids are rejected

Options:
  --account <adAccountId>  Local id from ads accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads advertisements`](/docs/cli/commands/ads/advertisements): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/advertisements/update-tracking-tags -->

# `smallforce ads advertisements update-tracking-tags`

Update tracking parameters for a Meta advertisement

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads advertisements update-tracking-tags --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads advertisements update-tracking-tags [options] <targetId>

Update tracking parameters for a Meta advertisement

Arguments:
  targetId                 SmallForce-local advertisement id; raw Meta ids are rejected

Options:
  --account <adAccountId>  Local id from ads accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads advertisements`](/docs/cli/commands/ads/advertisements): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/advertisements/comments -->

# `smallforce ads advertisements comments`

Read comments attached to a Meta advertisement

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads advertisements comments --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads advertisements comments [options] <targetId>

Read comments attached to a Meta advertisement

Arguments:
  targetId                 SmallForce-local advertisement id; raw Meta ids are rejected

Options:
  --account <adAccountId>  Local id from ads accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads advertisements`](/docs/cli/commands/ads/advertisements): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/reports -->

# `smallforce ads reports`

Run and retrieve asynchronous Meta Insights reports

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads reports --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce ads reports create`](/docs/cli/commands/ads/reports/create): Submit an asynchronous Meta Insights report
- [`smallforce ads reports get`](/docs/cli/commands/ads/reports/get): Poll or page one asynchronous Meta Insights report
- [`smallforce ads reports wait`](/docs/cli/commands/ads/reports/wait): Wait for an asynchronous Meta Insights report to finish

## Complete command help

```text
Usage: smallforce ads reports [options] [command]

Run and retrieve asynchronous Meta Insights reports

Options:
  -h, --help                 display help for command

Commands:
  create [options]           Submit an asynchronous Meta Insights report
  get [options] <reportId>   Poll or page one asynchronous Meta Insights report
  wait [options] <reportId>  Wait for an asynchronous Meta Insights report to finish
  help [command]             display help for command
```

## Related reference

- [`smallforce ads`](/docs/cli/commands/ads): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/reports/create -->

# `smallforce ads reports create`

Submit an asynchronous Meta Insights report

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads reports create --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads reports create [options]

Submit an asynchronous Meta Insights report

Options:
  --account <adAccountId>  Local id from ads accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads reports`](/docs/cli/commands/ads/reports): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/reports/get -->

# `smallforce ads reports get`

Poll or page one asynchronous Meta Insights report

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads reports get --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads reports get [options] <reportId>

Poll or page one asynchronous Meta Insights report

Arguments:
  reportId                 Local report id returned by reports create

Options:
  --account <adAccountId>  Local id from ads accounts list
  --cursor <cursor>        Opaque cursor from the previous JSON page
  --limit <n>              Rows per completed page, 1 to 500
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads reports`](/docs/cli/commands/ads/reports): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/reports/wait -->

# `smallforce ads reports wait`

Wait for an asynchronous Meta Insights report to finish

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads reports wait --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads reports wait [options] <reportId>

Wait for an asynchronous Meta Insights report to finish

Arguments:
  reportId                   Local report id returned by reports create

Options:
  --account <adAccountId>    Local id from ads accounts list
  --cursor <cursor>          Opaque cursor from a completed report page
  --limit <n>                Rows per completed page, 1 to 500
  --poll-interval <seconds>  Polling interval, 1 to 60 (default: "3")
  --timeout <seconds>        Maximum wait, 1 to 3600 (default: "300")
  --api-key <key>            SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>        SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                     Print stable machine-readable JSON
  --text                     Print human-readable text
  --format <format>          Output format: text or json
  -h, --help                 display help for command
```

## Related reference

- [`smallforce ads reports`](/docs/cli/commands/ads/reports): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/targeting -->

# `smallforce ads targeting`

Search Meta targeting values and estimate audience reach

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads targeting --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce ads targeting search`](/docs/cli/commands/ads/targeting/search): Search valid Meta geographic, interest, behavior, or income targets
- [`smallforce ads targeting estimate`](/docs/cli/commands/ads/targeting/estimate): Estimate reach for a complete Meta targeting spec

## Complete command help

```text
Usage: smallforce ads targeting [options] [command]

Search Meta targeting values and estimate audience reach

Options:
  -h, --help                display help for command

Commands:
  search [options] <query>  Search valid Meta geographic, interest, behavior, or income targets
  estimate [options]        Estimate reach for a complete Meta targeting spec
  help [command]            display help for command
```

## Related reference

- [`smallforce ads`](/docs/cli/commands/ads): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/targeting/search -->

# `smallforce ads targeting search`

Search valid Meta geographic, interest, behavior, or income targets

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads targeting search --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads targeting search [options] <query>

Search valid Meta geographic, interest, behavior, or income targets

Arguments:
  query                    Audience or location search text

Options:
  --account <adAccountId>  Local id from ads accounts list
  --dimension <dimension>  geo, interest, behavior, income, language, workPosition, workEmployer, or
                           workIndustry (default: "interest")
  --geo-type <type>        country, country_group, region, city, zip, metro_area, place, or
                           neighborhood
  --country <code>         Two-letter country code for geo searches
  --limit <n>              Results to return, 1 to 100
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads targeting`](/docs/cli/commands/ads/targeting): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/targeting/estimate -->

# `smallforce ads targeting estimate`

Estimate reach for a complete Meta targeting spec

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads targeting estimate --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads targeting estimate [options]

Estimate reach for a complete Meta targeting spec

Options:
  --account <adAccountId>     Local id from ads accounts list
  --optimization-goal <goal>  Optional provider optimization goal
  --input <json>              Inline JSON request object
  --input-file <path>         JSON request file; use - to read from stdin
  --api-key <key>             SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>         SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                      Print stable machine-readable JSON
  --text                      Print human-readable text
  --format <format>           Output format: text or json
  -h, --help                  display help for command
```

## Related reference

- [`smallforce ads targeting`](/docs/cli/commands/ads/targeting): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/predictable-reach -->

# `smallforce ads predictable-reach`

Quote, reserve, inspect, and release Meta Reach & Frequency delivery

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads predictable-reach --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce ads predictable-reach quote`](/docs/cli/commands/ads/predictable-reach/quote): Create a Meta predictable-reach quote
- [`smallforce ads predictable-reach get`](/docs/cli/commands/ads/predictable-reach/get): Read a predictable-reach quote or reservation
- [`smallforce ads predictable-reach reserve`](/docs/cli/commands/ads/predictable-reach/reserve): Reserve inventory for a predictable-reach quote
- [`smallforce ads predictable-reach release`](/docs/cli/commands/ads/predictable-reach/release): Release a predictable-reach reservation

## Complete command help

```text
Usage: smallforce ads predictable-reach [options] [command]

Quote, reserve, inspect, and release Meta Reach & Frequency delivery

Options:
  -h, --help                        display help for command

Commands:
  quote [options]                   Create a Meta predictable-reach quote
  get [options] <predictionId>      Read a predictable-reach quote or reservation
  reserve [options] <predictionId>  Reserve inventory for a predictable-reach quote
  release [options] <predictionId>  Release a predictable-reach reservation
  help [command]                    display help for command
```

## Related reference

- [`smallforce ads`](/docs/cli/commands/ads): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/predictable-reach/quote -->

# `smallforce ads predictable-reach quote`

Create a Meta predictable-reach quote

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads predictable-reach quote --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads predictable-reach quote [options]

Create a Meta predictable-reach quote

Options:
  --account <adAccountId>  Local id from ads accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads predictable-reach`](/docs/cli/commands/ads/predictable-reach): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/predictable-reach/get -->

# `smallforce ads predictable-reach get`

Read a predictable-reach quote or reservation

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads predictable-reach get --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads predictable-reach get [options] <predictionId>

Read a predictable-reach quote or reservation

Arguments:
  predictionId             Prediction id returned by quote

Options:
  --account <adAccountId>  Local id from ads accounts list
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads predictable-reach`](/docs/cli/commands/ads/predictable-reach): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/predictable-reach/reserve -->

# `smallforce ads predictable-reach reserve`

Reserve inventory for a predictable-reach quote

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads predictable-reach reserve --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads predictable-reach reserve [options] <predictionId>

Reserve inventory for a predictable-reach quote

Arguments:
  predictionId             Prediction id returned by quote

Options:
  --account <adAccountId>  Local id from ads accounts list
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads predictable-reach`](/docs/cli/commands/ads/predictable-reach): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/predictable-reach/release -->

# `smallforce ads predictable-reach release`

Release a predictable-reach reservation

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads predictable-reach release --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads predictable-reach release [options] <predictionId>

Release a predictable-reach reservation

Arguments:
  predictionId             Reserved prediction id

Options:
  --account <adAccountId>  Local id from ads accounts list
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads predictable-reach`](/docs/cli/commands/ads/predictable-reach): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/lead-forms -->

# `smallforce ads lead-forms`

List, create, inspect, archive, test, and read Meta Instant Forms

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads lead-forms --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce ads lead-forms list`](/docs/cli/commands/ads/lead-forms/list): List Meta Instant Forms accessible to an ad account
- [`smallforce ads lead-forms get`](/docs/cli/commands/ads/lead-forms/get): Get one Meta Instant Form
- [`smallforce ads lead-forms create`](/docs/cli/commands/ads/lead-forms/create): Create a Meta Instant Form
- [`smallforce ads lead-forms archive`](/docs/cli/commands/ads/lead-forms/archive): Archive one Meta Instant Form
- [`smallforce ads lead-forms test-lead`](/docs/cli/commands/ads/lead-forms/test-lead): Create a Meta test lead for one Instant Form
- [`smallforce ads lead-forms form-leads`](/docs/cli/commands/ads/lead-forms/form-leads): List leads submitted to one Meta Instant Form

## Complete command help

```text
Usage: smallforce ads lead-forms [options] [command]

List, create, inspect, archive, test, and read Meta Instant Forms

Options:
  -h, --help                       display help for command

Commands:
  list [options]                   List Meta Instant Forms accessible to an ad account
  get [options] <formId>           Get one Meta Instant Form
  create [options]                 Create a Meta Instant Form
  archive [options] <formId>       Archive one Meta Instant Form
  test-lead [options] <formId>     Create a Meta test lead for one Instant Form
  form-leads [options] <targetId>  List leads submitted to one Meta Instant Form
  help [command]                   display help for command
```

## Related reference

- [`smallforce ads`](/docs/cli/commands/ads): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/lead-forms/list -->

# `smallforce ads lead-forms list`

List Meta Instant Forms accessible to an ad account

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads lead-forms list --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads lead-forms list [options]

List Meta Instant Forms accessible to an ad account

Options:
  --account <adAccountId>  Local id from ads accounts list
  --cursor <cursor>        Opaque provider cursor from the previous page
  --limit <n>              Forms per page, 1 to 100
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads lead-forms`](/docs/cli/commands/ads/lead-forms): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/lead-forms/get -->

# `smallforce ads lead-forms get`

Get one Meta Instant Form

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads lead-forms get --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads lead-forms get [options] <formId>

Get one Meta Instant Form

Arguments:
  formId                   Local form id from lead-forms list

Options:
  --account <adAccountId>  Local id from ads accounts list
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads lead-forms`](/docs/cli/commands/ads/lead-forms): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/lead-forms/create -->

# `smallforce ads lead-forms create`

Create a Meta Instant Form

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads lead-forms create --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads lead-forms create [options]

Create a Meta Instant Form

Options:
  --account <adAccountId>  Local id from ads accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads lead-forms`](/docs/cli/commands/ads/lead-forms): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/lead-forms/archive -->

# `smallforce ads lead-forms archive`

Archive one Meta Instant Form

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads lead-forms archive --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads lead-forms archive [options] <formId>

Archive one Meta Instant Form

Arguments:
  formId                   Local form id from lead-forms list

Options:
  --account <adAccountId>  Local id from ads accounts list
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads lead-forms`](/docs/cli/commands/ads/lead-forms): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/lead-forms/test-lead -->

# `smallforce ads lead-forms test-lead`

Create a Meta test lead for one Instant Form

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads lead-forms test-lead --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads lead-forms test-lead [options] <formId>

Create a Meta test lead for one Instant Form

Arguments:
  formId                   Local form id from lead-forms list

Options:
  --account <adAccountId>  Local id from ads accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads lead-forms`](/docs/cli/commands/ads/lead-forms): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/lead-forms/form-leads -->

# `smallforce ads lead-forms form-leads`

List leads submitted to one Meta Instant Form

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads lead-forms form-leads --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads lead-forms form-leads [options] <targetId>

List leads submitted to one Meta Instant Form

Arguments:
  targetId                 SmallForce-local lead-form id; raw Meta ids are rejected

Options:
  --account <adAccountId>  Local id from ads accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads lead-forms`](/docs/cli/commands/ads/lead-forms): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/leads -->

# `smallforce ads leads`

Read captured Meta leads

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads leads --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce ads leads list`](/docs/cli/commands/ads/leads/list): List Meta leads for an advertising account

## Complete command help

```text
Usage: smallforce ads leads [options] [command]

Read captured Meta leads

Options:
  -h, --help      display help for command

Commands:
  list [options]  List Meta leads for an advertising account
  help [command]  display help for command
```

## Related reference

- [`smallforce ads`](/docs/cli/commands/ads): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/leads/list -->

# `smallforce ads leads list`

List Meta leads for an advertising account

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads leads list --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads leads list [options]

List Meta leads for an advertising account

Options:
  --account <adAccountId>  Local id from ads accounts list
  --form <formId>          Filter by one Meta lead-form id
  --since <iso>            Only leads created after this ISO timestamp
  --cursor <cursor>        Opaque provider cursor from the previous page
  --limit <n>              Leads per page, 1 to 100
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads leads`](/docs/cli/commands/ads/leads): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/account-users -->

# `smallforce ads account-users`

Manage Meta ad-account access

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads account-users --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce ads account-users assign`](/docs/cli/commands/ads/account-users/assign): Assign ad account user
- [`smallforce ads account-users list`](/docs/cli/commands/ads/account-users/list): List ad account users
- [`smallforce ads account-users remove`](/docs/cli/commands/ads/account-users/remove): Remove ad account user

## Complete command help

```text
Usage: smallforce ads account-users [options] [command]

Manage Meta ad-account access

Options:
  -h, --help                   display help for command

Commands:
  assign [options] <targetId>  Assign ad account user
  list [options] <targetId>    List ad account users
  remove [options] <targetId>  Remove ad account user
  help [command]               display help for command
```

## Related reference

- [`smallforce ads`](/docs/cli/commands/ads): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/account-users/assign -->

# `smallforce ads account-users assign`

Assign ad account user

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads account-users assign --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads account-users assign [options] <targetId>

Assign ad account user

Arguments:
  targetId                 SmallForce-local meta-business-user id; raw Meta ids are rejected

Options:
  --account <adAccountId>  Local id from ads accounts list
  --idempotency-key <key>  Idempotency key forwarded for provider mutations
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads account-users`](/docs/cli/commands/ads/account-users): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/account-users/list -->

# `smallforce ads account-users list`

List ad account users

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads account-users list --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads account-users list [options] <targetId>

List ad account users

Arguments:
  targetId                 SmallForce-local meta-business id; raw Meta ids are rejected

Options:
  --account <adAccountId>  Local id from ads accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads account-users`](/docs/cli/commands/ads/account-users): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/account-users/remove -->

# `smallforce ads account-users remove`

Remove ad account user

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads account-users remove --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads account-users remove [options] <targetId>

Remove ad account user

Arguments:
  targetId                 SmallForce-local meta-business-user id; raw Meta ids are rejected

Options:
  --account <adAccountId>  Local id from ads accounts list
  --idempotency-key <key>  Idempotency key forwarded for provider mutations
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads account-users`](/docs/cli/commands/ads/account-users): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/page-users -->

# `smallforce ads page-users`

Manage Facebook Page access

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads page-users --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce ads page-users assign`](/docs/cli/commands/ads/page-users/assign): Assign page user
- [`smallforce ads page-users list`](/docs/cli/commands/ads/page-users/list): List page users
- [`smallforce ads page-users remove`](/docs/cli/commands/ads/page-users/remove): Remove page user

## Complete command help

```text
Usage: smallforce ads page-users [options] [command]

Manage Facebook Page access

Options:
  -h, --help                   display help for command

Commands:
  assign [options] <targetId>  Assign page user
  list [options] <targetId>    List page users
  remove [options] <targetId>  Remove page user
  help [command]               display help for command
```

## Related reference

- [`smallforce ads`](/docs/cli/commands/ads): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/page-users/assign -->

# `smallforce ads page-users assign`

Assign page user

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads page-users assign --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads page-users assign [options] <targetId>

Assign page user

Arguments:
  targetId                 SmallForce-local facebook-page id; raw Meta ids are rejected

Options:
  --account <adAccountId>  Local id from ads accounts list
  --idempotency-key <key>  Idempotency key forwarded for provider mutations
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads page-users`](/docs/cli/commands/ads/page-users): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/page-users/list -->

# `smallforce ads page-users list`

List page users

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads page-users list --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads page-users list [options] <targetId>

List page users

Arguments:
  targetId                 SmallForce-local facebook-page id; raw Meta ids are rejected

Options:
  --account <adAccountId>  Local id from ads accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads page-users`](/docs/cli/commands/ads/page-users): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/page-users/remove -->

# `smallforce ads page-users remove`

Remove page user

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads page-users remove --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads page-users remove [options] <targetId>

Remove page user

Arguments:
  targetId                 SmallForce-local facebook-page id; raw Meta ids are rejected

Options:
  --account <adAccountId>  Local id from ads accounts list
  --idempotency-key <key>  Idempotency key forwarded for provider mutations
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads page-users`](/docs/cli/commands/ads/page-users): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/videos -->

# `smallforce ads videos`

Manage Meta Ads videos

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads videos --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce ads videos status`](/docs/cli/commands/ads/videos/status): Get ad video status

## Complete command help

```text
Usage: smallforce ads videos [options] [command]

Manage Meta Ads videos

Options:
  -h, --help                   display help for command

Commands:
  status [options] <targetId>  Get ad video status
  help [command]               display help for command
```

## Related reference

- [`smallforce ads`](/docs/cli/commands/ads): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/videos/status -->

# `smallforce ads videos status`

Get ad video status

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads videos status --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads videos status [options] <targetId>

Get ad video status

Arguments:
  targetId                 SmallForce-local video id; raw Meta ids are rejected

Options:
  --account <adAccountId>  Local id from ads accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads videos`](/docs/cli/commands/ads/videos): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/business-users -->

# `smallforce ads business-users`

Discover Meta business users and system users

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads business-users --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce ads business-users list`](/docs/cli/commands/ads/business-users/list): List meta business users

## Complete command help

```text
Usage: smallforce ads business-users [options] [command]

Discover Meta business users and system users

Options:
  -h, --help                 display help for command

Commands:
  list [options] <targetId>  List meta business users
  help [command]             display help for command
```

## Related reference

- [`smallforce ads`](/docs/cli/commands/ads): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/business-users/list -->

# `smallforce ads business-users list`

List meta business users

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads business-users list --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads business-users list [options] <targetId>

List meta business users

Arguments:
  targetId                 SmallForce-local meta-business id; raw Meta ids are rejected

Options:
  --account <adAccountId>  Local id from ads accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads business-users`](/docs/cli/commands/ads/business-users): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/instagram-posts -->

# `smallforce ads instagram-posts`

Manage Meta Ads instagram-posts

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads instagram-posts --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce ads instagram-posts list`](/docs/cli/commands/ads/instagram-posts/list): List Instagram posts to boost

## Complete command help

```text
Usage: smallforce ads instagram-posts [options] [command]

Manage Meta Ads instagram-posts

Options:
  -h, --help      display help for command

Commands:
  list [options]  List Instagram posts to boost
  help [command]  display help for command
```

## Related reference

- [`smallforce ads`](/docs/cli/commands/ads): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/instagram-posts/list -->

# `smallforce ads instagram-posts list`

List Instagram posts to boost

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads instagram-posts list --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads instagram-posts list [options]

List Instagram posts to boost

Options:
  --account <adAccountId>  Local id from ads accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads instagram-posts`](/docs/cli/commands/ads/instagram-posts): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/test-leads -->

# `smallforce ads test-leads`

Manage Meta Ads test-leads

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads test-leads --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce ads test-leads delete`](/docs/cli/commands/ads/test-leads/delete): Delete a test lead

## Complete command help

```text
Usage: smallforce ads test-leads [options] [command]

Manage Meta Ads test-leads

Options:
  -h, --help                   display help for command

Commands:
  delete [options] <targetId>  Delete a test lead
  help [command]               display help for command
```

## Related reference

- [`smallforce ads`](/docs/cli/commands/ads): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/test-leads/delete -->

# `smallforce ads test-leads delete`

Delete a test lead

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads test-leads delete --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads test-leads delete [options] <targetId>

Delete a test lead

Arguments:
  targetId                 SmallForce-local lead-form id; raw Meta ids are rejected

Options:
  --account <adAccountId>  Local id from ads accounts list
  --idempotency-key <key>  Idempotency key forwarded for provider mutations
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads test-leads`](/docs/cli/commands/ads/test-leads): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/catalogs -->

# `smallforce ads catalogs`

Manage Meta Ads catalogs

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads catalogs --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce ads catalogs create`](/docs/cli/commands/ads/catalogs/create): Create a Meta product catalog
- [`smallforce ads catalogs get`](/docs/cli/commands/ads/catalogs/get): Get a product catalog
- [`smallforce ads catalogs delete`](/docs/cli/commands/ads/catalogs/delete): Delete a product catalog

## Complete command help

```text
Usage: smallforce ads catalogs [options] [command]

Manage Meta Ads catalogs

Options:
  -h, --help                   display help for command

Commands:
  create [options]             Create a Meta product catalog
  get [options] <targetId>     Get a product catalog
  delete [options] <targetId>  Delete a product catalog
  help [command]               display help for command
```

## Related reference

- [`smallforce ads`](/docs/cli/commands/ads): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/catalogs/create -->

# `smallforce ads catalogs create`

Create a Meta product catalog

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads catalogs create --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads catalogs create [options]

Create a Meta product catalog

Options:
  --account <adAccountId>  Local id from ads accounts list
  --idempotency-key <key>  Idempotency key forwarded for provider mutations
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads catalogs`](/docs/cli/commands/ads/catalogs): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/catalogs/get -->

# `smallforce ads catalogs get`

Get a product catalog

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads catalogs get --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads catalogs get [options] <targetId>

Get a product catalog

Arguments:
  targetId                 SmallForce-local catalog id; raw Meta ids are rejected

Options:
  --account <adAccountId>  Local id from ads accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads catalogs`](/docs/cli/commands/ads/catalogs): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/catalogs/delete -->

# `smallforce ads catalogs delete`

Delete a product catalog

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads catalogs delete --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads catalogs delete [options] <targetId>

Delete a product catalog

Arguments:
  targetId                 SmallForce-local catalog id; raw Meta ids are rejected

Options:
  --account <adAccountId>  Local id from ads accounts list
  --idempotency-key <key>  Idempotency key forwarded for provider mutations
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads catalogs`](/docs/cli/commands/ads/catalogs): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/catalog-products -->

# `smallforce ads catalog-products`

Manage Meta Ads catalog-products

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads catalog-products --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce ads catalog-products list`](/docs/cli/commands/ads/catalog-products/list): List a catalog's products
- [`smallforce ads catalog-products create`](/docs/cli/commands/ads/catalog-products/create): Add a product to a catalog
- [`smallforce ads catalog-products batch`](/docs/cli/commands/ads/catalog-products/batch): Create, update or delete products in bulk
- [`smallforce ads catalog-products get`](/docs/cli/commands/ads/catalog-products/get): Get a product
- [`smallforce ads catalog-products update`](/docs/cli/commands/ads/catalog-products/update): Update a product
- [`smallforce ads catalog-products delete`](/docs/cli/commands/ads/catalog-products/delete): Delete a product

## Complete command help

```text
Usage: smallforce ads catalog-products [options] [command]

Manage Meta Ads catalog-products

Options:
  -h, --help                   display help for command

Commands:
  list [options] <targetId>    List a catalog's products
  create [options] <targetId>  Add a product to a catalog
  batch [options] <targetId>   Create, update or delete products in bulk
  get [options] <targetId>     Get a product
  update [options] <targetId>  Update a product
  delete [options] <targetId>  Delete a product
  help [command]               display help for command
```

## Related reference

- [`smallforce ads`](/docs/cli/commands/ads): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/catalog-products/list -->

# `smallforce ads catalog-products list`

List a catalog's products

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads catalog-products list --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads catalog-products list [options] <targetId>

List a catalog's products

Arguments:
  targetId                 SmallForce-local catalog id; raw Meta ids are rejected

Options:
  --account <adAccountId>  Local id from ads accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads catalog-products`](/docs/cli/commands/ads/catalog-products): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/catalog-products/create -->

# `smallforce ads catalog-products create`

Add a product to a catalog

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads catalog-products create --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads catalog-products create [options] <targetId>

Add a product to a catalog

Arguments:
  targetId                 SmallForce-local catalog id; raw Meta ids are rejected

Options:
  --account <adAccountId>  Local id from ads accounts list
  --idempotency-key <key>  Idempotency key forwarded for provider mutations
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads catalog-products`](/docs/cli/commands/ads/catalog-products): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/catalog-products/batch -->

# `smallforce ads catalog-products batch`

Create, update or delete products in bulk

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads catalog-products batch --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads catalog-products batch [options] <targetId>

Create, update or delete products in bulk

Arguments:
  targetId                 SmallForce-local catalog id; raw Meta ids are rejected

Options:
  --account <adAccountId>  Local id from ads accounts list
  --idempotency-key <key>  Idempotency key forwarded for provider mutations
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads catalog-products`](/docs/cli/commands/ads/catalog-products): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/catalog-products/get -->

# `smallforce ads catalog-products get`

Get a product

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads catalog-products get --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads catalog-products get [options] <targetId>

Get a product

Arguments:
  targetId                 SmallForce-local catalog-product id; raw Meta ids are rejected

Options:
  --account <adAccountId>  Local id from ads accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads catalog-products`](/docs/cli/commands/ads/catalog-products): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/catalog-products/update -->

# `smallforce ads catalog-products update`

Update a product

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads catalog-products update --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads catalog-products update [options] <targetId>

Update a product

Arguments:
  targetId                 SmallForce-local catalog-product id; raw Meta ids are rejected

Options:
  --account <adAccountId>  Local id from ads accounts list
  --idempotency-key <key>  Idempotency key forwarded for provider mutations
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads catalog-products`](/docs/cli/commands/ads/catalog-products): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/catalog-products/delete -->

# `smallforce ads catalog-products delete`

Delete a product

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads catalog-products delete --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads catalog-products delete [options] <targetId>

Delete a product

Arguments:
  targetId                 SmallForce-local catalog-product id; raw Meta ids are rejected

Options:
  --account <adAccountId>  Local id from ads accounts list
  --idempotency-key <key>  Idempotency key forwarded for provider mutations
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads catalog-products`](/docs/cli/commands/ads/catalog-products): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/catalog-batches -->

# `smallforce ads catalog-batches`

Manage Meta Ads catalog-batches

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads catalog-batches --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce ads catalog-batches get`](/docs/cli/commands/ads/catalog-batches/get): Get a bulk request's status

## Complete command help

```text
Usage: smallforce ads catalog-batches [options] [command]

Manage Meta Ads catalog-batches

Options:
  -h, --help                display help for command

Commands:
  get [options] <targetId>  Get a bulk request's status
  help [command]            display help for command
```

## Related reference

- [`smallforce ads`](/docs/cli/commands/ads): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/catalog-batches/get -->

# `smallforce ads catalog-batches get`

Get a bulk request's status

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads catalog-batches get --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads catalog-batches get [options] <targetId>

Get a bulk request's status

Arguments:
  targetId                 SmallForce-local catalog-batch id; raw Meta ids are rejected

Options:
  --account <adAccountId>  Local id from ads accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads catalog-batches`](/docs/cli/commands/ads/catalog-batches): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/catalog-feeds -->

# `smallforce ads catalog-feeds`

Manage Meta Ads catalog-feeds

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads catalog-feeds --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce ads catalog-feeds list`](/docs/cli/commands/ads/catalog-feeds/list): List a catalog's product feeds
- [`smallforce ads catalog-feeds create`](/docs/cli/commands/ads/catalog-feeds/create): Create a product feed

## Complete command help

```text
Usage: smallforce ads catalog-feeds [options] [command]

Manage Meta Ads catalog-feeds

Options:
  -h, --help                   display help for command

Commands:
  list [options] <targetId>    List a catalog's product feeds
  create [options] <targetId>  Create a product feed
  help [command]               display help for command
```

## Related reference

- [`smallforce ads`](/docs/cli/commands/ads): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/catalog-feeds/list -->

# `smallforce ads catalog-feeds list`

List a catalog's product feeds

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads catalog-feeds list --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads catalog-feeds list [options] <targetId>

List a catalog's product feeds

Arguments:
  targetId                 SmallForce-local catalog id; raw Meta ids are rejected

Options:
  --account <adAccountId>  Local id from ads accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads catalog-feeds`](/docs/cli/commands/ads/catalog-feeds): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/catalog-feeds/create -->

# `smallforce ads catalog-feeds create`

Create a product feed

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads catalog-feeds create --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads catalog-feeds create [options] <targetId>

Create a product feed

Arguments:
  targetId                 SmallForce-local catalog id; raw Meta ids are rejected

Options:
  --account <adAccountId>  Local id from ads accounts list
  --idempotency-key <key>  Idempotency key forwarded for provider mutations
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads catalog-feeds`](/docs/cli/commands/ads/catalog-feeds): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/catalog-uploads -->

# `smallforce ads catalog-uploads`

Manage Meta Ads catalog-uploads

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads catalog-uploads --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce ads catalog-uploads list`](/docs/cli/commands/ads/catalog-uploads/list): List a feed's uploads
- [`smallforce ads catalog-uploads create`](/docs/cli/commands/ads/catalog-uploads/create): Fetch a feed file now

## Complete command help

```text
Usage: smallforce ads catalog-uploads [options] [command]

Manage Meta Ads catalog-uploads

Options:
  -h, --help                   display help for command

Commands:
  list [options] <targetId>    List a feed's uploads
  create [options] <targetId>  Fetch a feed file now
  help [command]               display help for command
```

## Related reference

- [`smallforce ads`](/docs/cli/commands/ads): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/catalog-uploads/list -->

# `smallforce ads catalog-uploads list`

List a feed's uploads

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads catalog-uploads list --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads catalog-uploads list [options] <targetId>

List a feed's uploads

Arguments:
  targetId                 SmallForce-local catalog-feed id; raw Meta ids are rejected

Options:
  --account <adAccountId>  Local id from ads accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads catalog-uploads`](/docs/cli/commands/ads/catalog-uploads): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/catalog-uploads/create -->

# `smallforce ads catalog-uploads create`

Fetch a feed file now

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads catalog-uploads create --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads catalog-uploads create [options] <targetId>

Fetch a feed file now

Arguments:
  targetId                 SmallForce-local catalog-feed id; raw Meta ids are rejected

Options:
  --account <adAccountId>  Local id from ads accounts list
  --idempotency-key <key>  Idempotency key forwarded for provider mutations
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads catalog-uploads`](/docs/cli/commands/ads/catalog-uploads): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/catalog-sets -->

# `smallforce ads catalog-sets`

Manage Meta Ads catalog-sets

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads catalog-sets --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce ads catalog-sets create`](/docs/cli/commands/ads/catalog-sets/create): Create a product set
- [`smallforce ads catalog-sets update`](/docs/cli/commands/ads/catalog-sets/update): Update a product set
- [`smallforce ads catalog-sets delete`](/docs/cli/commands/ads/catalog-sets/delete): Delete a product set

## Complete command help

```text
Usage: smallforce ads catalog-sets [options] [command]

Manage Meta Ads catalog-sets

Options:
  -h, --help                   display help for command

Commands:
  create [options] <targetId>  Create a product set
  update [options] <targetId>  Update a product set
  delete [options] <targetId>  Delete a product set
  help [command]               display help for command
```

## Related reference

- [`smallforce ads`](/docs/cli/commands/ads): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/catalog-sets/create -->

# `smallforce ads catalog-sets create`

Create a product set

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads catalog-sets create --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads catalog-sets create [options] <targetId>

Create a product set

Arguments:
  targetId                 SmallForce-local catalog id; raw Meta ids are rejected

Options:
  --account <adAccountId>  Local id from ads accounts list
  --idempotency-key <key>  Idempotency key forwarded for provider mutations
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads catalog-sets`](/docs/cli/commands/ads/catalog-sets): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/catalog-sets/update -->

# `smallforce ads catalog-sets update`

Update a product set

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads catalog-sets update --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads catalog-sets update [options] <targetId>

Update a product set

Arguments:
  targetId                 SmallForce-local catalog-product-set id; raw Meta ids are rejected

Options:
  --account <adAccountId>  Local id from ads accounts list
  --idempotency-key <key>  Idempotency key forwarded for provider mutations
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads catalog-sets`](/docs/cli/commands/ads/catalog-sets): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/catalog-sets/delete -->

# `smallforce ads catalog-sets delete`

Delete a product set

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads catalog-sets delete --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads catalog-sets delete [options] <targetId>

Delete a product set

Arguments:
  targetId                 SmallForce-local catalog-product-set id; raw Meta ids are rejected

Options:
  --account <adAccountId>  Local id from ads accounts list
  --idempotency-key <key>  Idempotency key forwarded for provider mutations
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads catalog-sets`](/docs/cli/commands/ads/catalog-sets): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/identities -->

# `smallforce ads identities`

Manage Meta Ads identities

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads identities --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce ads identities list`](/docs/cli/commands/ads/identities/list): List Instagram ad identities

## Complete command help

```text
Usage: smallforce ads identities [options] [command]

Manage Meta Ads identities

Options:
  -h, --help      display help for command

Commands:
  list [options]  List Instagram ad identities
  help [command]  display help for command
```

## Related reference

- [`smallforce ads`](/docs/cli/commands/ads): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/identities/list -->

# `smallforce ads identities list`

List Instagram ad identities

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads identities list --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads identities list [options]

List Instagram ad identities

Options:
  --account <adAccountId>  Local id from ads accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads identities`](/docs/cli/commands/ads/identities): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/applications -->

# `smallforce ads applications`

Manage Meta Ads applications

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads applications --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce ads applications list`](/docs/cli/commands/ads/applications/list): List advertisable apps
- [`smallforce ads applications ios-limits`](/docs/cli/commands/ads/applications/ios-limits): Get iOS 14 campaign limits

## Complete command help

```text
Usage: smallforce ads applications [options] [command]

Manage Meta Ads applications

Options:
  -h, --help            display help for command

Commands:
  list [options]        List advertisable apps
  ios-limits [options]  Get iOS 14 campaign limits
  help [command]        display help for command
```

## Related reference

- [`smallforce ads`](/docs/cli/commands/ads): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/applications/list -->

# `smallforce ads applications list`

List advertisable apps

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads applications list --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads applications list [options]

List advertisable apps

Options:
  --account <adAccountId>  Local id from ads accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads applications`](/docs/cli/commands/ads/applications): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/applications/ios-limits -->

# `smallforce ads applications ios-limits`

Get iOS 14 campaign limits

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads applications ios-limits --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads applications ios-limits [options]

Get iOS 14 campaign limits

Options:
  --account <adAccountId>  Local id from ads accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads applications`](/docs/cli/commands/ads/applications): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/partnerships -->

# `smallforce ads partnerships`

Manage Meta Ads partnerships

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads partnerships --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce ads partnerships content`](/docs/cli/commands/ads/partnerships/content): List partnership ad content
- [`smallforce ads partnerships permissions`](/docs/cli/commands/ads/partnerships/permissions): List partnership permissions
- [`smallforce ads partnerships set-permission`](/docs/cli/commands/ads/partnerships/set-permission): Set partnership permission

## Complete command help

```text
Usage: smallforce ads partnerships [options] [command]

Manage Meta Ads partnerships

Options:
  -h, --help                display help for command

Commands:
  content [options]         List partnership ad content
  permissions [options]     List partnership permissions
  set-permission [options]  Set partnership permission
  help [command]            display help for command
```

## Related reference

- [`smallforce ads`](/docs/cli/commands/ads): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/partnerships/content -->

# `smallforce ads partnerships content`

List partnership ad content

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads partnerships content --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads partnerships content [options]

List partnership ad content

Options:
  --account <adAccountId>  Local id from ads accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads partnerships`](/docs/cli/commands/ads/partnerships): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/partnerships/permissions -->

# `smallforce ads partnerships permissions`

List partnership permissions

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads partnerships permissions --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads partnerships permissions [options]

List partnership permissions

Options:
  --account <adAccountId>  Local id from ads accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads partnerships`](/docs/cli/commands/ads/partnerships): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/partnerships/set-permission -->

# `smallforce ads partnerships set-permission`

Set partnership permission

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads partnerships set-permission --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads partnerships set-permission [options]

Set partnership permission

Options:
  --account <adAccountId>  Local id from ads accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads partnerships`](/docs/cli/commands/ads/partnerships): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/insights -->

# `smallforce ads insights`

Run synchronous Meta advertising insights queries

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads insights --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce ads insights query`](/docs/cli/commands/ads/insights/query): Run a synchronous Meta Insights query

## Complete command help

```text
Usage: smallforce ads insights [options] [command]

Run synchronous Meta advertising insights queries

Options:
  -h, --help                  display help for command

Commands:
  query [options] <targetId>  Run a synchronous Meta Insights query
  help [command]              display help for command
```

## Related reference

- [`smallforce ads`](/docs/cli/commands/ads): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/insights/query -->

# `smallforce ads insights query`

Run a synchronous Meta Insights query

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads insights query --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads insights query [options] <targetId>

Run a synchronous Meta Insights query

Arguments:
  targetId                 SmallForce-local ad-account, campaign, ad-set, or advertisement id; raw
                           Meta ids are rejected

Options:
  --account <adAccountId>  Local id from ads accounts list
  --target-kind <kind>     ad_account, campaign, ad_set, or ad
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads insights`](/docs/cli/commands/ads/insights): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/creatives -->

# `smallforce ads creatives`

Manage reusable Meta creatives, images, videos, and catalogs

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads creatives --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce ads creatives list`](/docs/cli/commands/ads/creatives/list): List reusable Meta ad creatives
- [`smallforce ads creatives create`](/docs/cli/commands/ads/creatives/create): Create a reusable Meta ad creative
- [`smallforce ads creatives get`](/docs/cli/commands/ads/creatives/get): Read a reusable Meta ad creative
- [`smallforce ads creatives update`](/docs/cli/commands/ads/creatives/update): Update a reusable Meta ad creative
- [`smallforce ads creatives delete`](/docs/cli/commands/ads/creatives/delete): Delete a reusable Meta ad creative
- [`smallforce ads creatives upload-image`](/docs/cli/commands/ads/creatives/upload-image): Upload a SmallForce image asset to Meta Ads
- [`smallforce ads creatives list-images`](/docs/cli/commands/ads/creatives/list-images): List Meta ad-account images
- [`smallforce ads creatives upload-video`](/docs/cli/commands/ads/creatives/upload-video): Upload a SmallForce video asset to Meta Ads
- [`smallforce ads creatives list-videos`](/docs/cli/commands/ads/creatives/list-videos): List Meta ad-account videos
- [`smallforce ads creatives delete-video`](/docs/cli/commands/ads/creatives/delete-video): Delete a Meta ad-account video
- [`smallforce ads creatives catalogs`](/docs/cli/commands/ads/creatives/catalogs): List Meta commerce catalogs
- [`smallforce ads creatives product-sets`](/docs/cli/commands/ads/creatives/product-sets): List product sets in a Meta catalog

## Complete command help

```text
Usage: smallforce ads creatives [options] [command]

Manage reusable Meta creatives, images, videos, and catalogs

Options:
  -h, --help                         display help for command

Commands:
  list [options]                     List reusable Meta ad creatives
  create [options]                   Create a reusable Meta ad creative
  get [options] <targetId>           Read a reusable Meta ad creative
  update [options] <targetId>        Update a reusable Meta ad creative
  delete [options] <targetId>        Delete a reusable Meta ad creative
  upload-image [options]             Upload a SmallForce image asset to Meta Ads
  list-images [options]              List Meta ad-account images
  upload-video [options]             Upload a SmallForce video asset to Meta Ads
  list-videos [options]              List Meta ad-account videos
  delete-video [options] <targetId>  Delete a Meta ad-account video
  catalogs [options]                 List Meta commerce catalogs
  product-sets [options] <targetId>  List product sets in a Meta catalog
  help [command]                     display help for command
```

## Related reference

- [`smallforce ads`](/docs/cli/commands/ads): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/creatives/list -->

# `smallforce ads creatives list`

List reusable Meta ad creatives

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads creatives list --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads creatives list [options]

List reusable Meta ad creatives

Options:
  --account <adAccountId>  Local id from ads accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads creatives`](/docs/cli/commands/ads/creatives): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/creatives/create -->

# `smallforce ads creatives create`

Create a reusable Meta ad creative

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads creatives create --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads creatives create [options]

Create a reusable Meta ad creative

Options:
  --account <adAccountId>  Local id from ads accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads creatives`](/docs/cli/commands/ads/creatives): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/creatives/get -->

# `smallforce ads creatives get`

Read a reusable Meta ad creative

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads creatives get --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads creatives get [options] <targetId>

Read a reusable Meta ad creative

Arguments:
  targetId                 SmallForce-local creative id; raw Meta ids are rejected

Options:
  --account <adAccountId>  Local id from ads accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads creatives`](/docs/cli/commands/ads/creatives): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/creatives/update -->

# `smallforce ads creatives update`

Update a reusable Meta ad creative

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads creatives update --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads creatives update [options] <targetId>

Update a reusable Meta ad creative

Arguments:
  targetId                 SmallForce-local creative id; raw Meta ids are rejected

Options:
  --account <adAccountId>  Local id from ads accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads creatives`](/docs/cli/commands/ads/creatives): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/creatives/delete -->

# `smallforce ads creatives delete`

Delete a reusable Meta ad creative

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads creatives delete --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads creatives delete [options] <targetId>

Delete a reusable Meta ad creative

Arguments:
  targetId                 SmallForce-local creative id; raw Meta ids are rejected

Options:
  --account <adAccountId>  Local id from ads accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads creatives`](/docs/cli/commands/ads/creatives): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/creatives/upload-image -->

# `smallforce ads creatives upload-image`

Upload a SmallForce image asset to Meta Ads

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads creatives upload-image --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads creatives upload-image [options]

Upload a SmallForce image asset to Meta Ads

Options:
  --account <adAccountId>  Local id from ads accounts list
  --asset <assetId>        SmallForce image asset id
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads creatives`](/docs/cli/commands/ads/creatives): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/creatives/list-images -->

# `smallforce ads creatives list-images`

List Meta ad-account images

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads creatives list-images --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads creatives list-images [options]

List Meta ad-account images

Options:
  --account <adAccountId>  Local id from ads accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads creatives`](/docs/cli/commands/ads/creatives): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/creatives/upload-video -->

# `smallforce ads creatives upload-video`

Upload a SmallForce video asset to Meta Ads

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads creatives upload-video --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads creatives upload-video [options]

Upload a SmallForce video asset to Meta Ads

Options:
  --account <adAccountId>  Local id from ads accounts list
  --asset <assetId>        SmallForce video asset id
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads creatives`](/docs/cli/commands/ads/creatives): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/creatives/list-videos -->

# `smallforce ads creatives list-videos`

List Meta ad-account videos

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads creatives list-videos --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads creatives list-videos [options]

List Meta ad-account videos

Options:
  --account <adAccountId>  Local id from ads accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads creatives`](/docs/cli/commands/ads/creatives): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/creatives/delete-video -->

# `smallforce ads creatives delete-video`

Delete a Meta ad-account video

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads creatives delete-video --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads creatives delete-video [options] <targetId>

Delete a Meta ad-account video

Arguments:
  targetId                 SmallForce-local video id; raw Meta ids are rejected

Options:
  --account <adAccountId>  Local id from ads accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads creatives`](/docs/cli/commands/ads/creatives): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/creatives/catalogs -->

# `smallforce ads creatives catalogs`

List Meta commerce catalogs

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads creatives catalogs --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads creatives catalogs [options]

List Meta commerce catalogs

Options:
  --account <adAccountId>  Local id from ads accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads creatives`](/docs/cli/commands/ads/creatives): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/creatives/product-sets -->

# `smallforce ads creatives product-sets`

List product sets in a Meta catalog

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads creatives product-sets --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads creatives product-sets [options] <targetId>

List product sets in a Meta catalog

Arguments:
  targetId                 SmallForce-local catalog id; raw Meta ids are rejected

Options:
  --account <adAccountId>  Local id from ads accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads creatives`](/docs/cli/commands/ads/creatives): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/tracking-tags -->

# `smallforce ads tracking-tags`

Manage Meta pixels, datasets, sharing, and statistics

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads tracking-tags --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce ads tracking-tags list`](/docs/cli/commands/ads/tracking-tags/list): List Meta pixels and datasets
- [`smallforce ads tracking-tags create`](/docs/cli/commands/ads/tracking-tags/create): Create a Meta pixel
- [`smallforce ads tracking-tags get`](/docs/cli/commands/ads/tracking-tags/get): Read a Meta pixel
- [`smallforce ads tracking-tags update`](/docs/cli/commands/ads/tracking-tags/update): Update a Meta pixel
- [`smallforce ads tracking-tags shared-accounts`](/docs/cli/commands/ads/tracking-tags/shared-accounts): List ad accounts sharing a Meta pixel
- [`smallforce ads tracking-tags share`](/docs/cli/commands/ads/tracking-tags/share): Share a Meta pixel with another local ad account
- [`smallforce ads tracking-tags unshare`](/docs/cli/commands/ads/tracking-tags/unshare): Remove a Meta pixel from another local ad account
- [`smallforce ads tracking-tags stats`](/docs/cli/commands/ads/tracking-tags/stats): Read Meta pixel event statistics

## Complete command help

```text
Usage: smallforce ads tracking-tags [options] [command]

Manage Meta pixels, datasets, sharing, and statistics

Options:
  -h, --help                            display help for command

Commands:
  list [options]                        List Meta pixels and datasets
  create [options]                      Create a Meta pixel
  get [options] <targetId>              Read a Meta pixel
  update [options] <targetId>           Update a Meta pixel
  shared-accounts [options] <targetId>  List ad accounts sharing a Meta pixel
  share [options] <targetId>            Share a Meta pixel with another local ad account
  unshare [options] <targetId>          Remove a Meta pixel from another local ad account
  stats [options] <targetId>            Read Meta pixel event statistics
  help [command]                        display help for command
```

## Related reference

- [`smallforce ads`](/docs/cli/commands/ads): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/tracking-tags/list -->

# `smallforce ads tracking-tags list`

List Meta pixels and datasets

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads tracking-tags list --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads tracking-tags list [options]

List Meta pixels and datasets

Options:
  --account <adAccountId>  Local id from ads accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads tracking-tags`](/docs/cli/commands/ads/tracking-tags): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/tracking-tags/create -->

# `smallforce ads tracking-tags create`

Create a Meta pixel

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads tracking-tags create --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads tracking-tags create [options]

Create a Meta pixel

Options:
  --account <adAccountId>  Local id from ads accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads tracking-tags`](/docs/cli/commands/ads/tracking-tags): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/tracking-tags/get -->

# `smallforce ads tracking-tags get`

Read a Meta pixel

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads tracking-tags get --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads tracking-tags get [options] <targetId>

Read a Meta pixel

Arguments:
  targetId                 SmallForce-local tracking-tag id; raw Meta ids are rejected

Options:
  --account <adAccountId>  Local id from ads accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads tracking-tags`](/docs/cli/commands/ads/tracking-tags): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/tracking-tags/update -->

# `smallforce ads tracking-tags update`

Update a Meta pixel

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads tracking-tags update --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads tracking-tags update [options] <targetId>

Update a Meta pixel

Arguments:
  targetId                 SmallForce-local tracking-tag id; raw Meta ids are rejected

Options:
  --account <adAccountId>  Local id from ads accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads tracking-tags`](/docs/cli/commands/ads/tracking-tags): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/tracking-tags/shared-accounts -->

# `smallforce ads tracking-tags shared-accounts`

List ad accounts sharing a Meta pixel

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads tracking-tags shared-accounts --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads tracking-tags shared-accounts [options] <targetId>

List ad accounts sharing a Meta pixel

Arguments:
  targetId                 SmallForce-local tracking-tag id; raw Meta ids are rejected

Options:
  --account <adAccountId>  Local id from ads accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads tracking-tags`](/docs/cli/commands/ads/tracking-tags): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/tracking-tags/share -->

# `smallforce ads tracking-tags share`

Share a Meta pixel with another local ad account

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads tracking-tags share --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads tracking-tags share [options] <targetId>

Share a Meta pixel with another local ad account

Arguments:
  targetId                 SmallForce-local tracking-tag id; raw Meta ids are rejected

Options:
  --account <adAccountId>  Local id from ads accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads tracking-tags`](/docs/cli/commands/ads/tracking-tags): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/tracking-tags/unshare -->

# `smallforce ads tracking-tags unshare`

Remove a Meta pixel from another local ad account

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads tracking-tags unshare --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads tracking-tags unshare [options] <targetId>

Remove a Meta pixel from another local ad account

Arguments:
  targetId                 SmallForce-local tracking-tag id; raw Meta ids are rejected

Options:
  --account <adAccountId>  Local id from ads accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads tracking-tags`](/docs/cli/commands/ads/tracking-tags): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/tracking-tags/stats -->

# `smallforce ads tracking-tags stats`

Read Meta pixel event statistics

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads tracking-tags stats --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads tracking-tags stats [options] <targetId>

Read Meta pixel event statistics

Arguments:
  targetId                 SmallForce-local tracking-tag id; raw Meta ids are rejected

Options:
  --account <adAccountId>  Local id from ads accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads tracking-tags`](/docs/cli/commands/ads/tracking-tags): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/audiences -->

# `smallforce ads audiences`

Manage Meta custom audiences

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads audiences --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce ads audiences list`](/docs/cli/commands/ads/audiences/list): List Meta custom audiences
- [`smallforce ads audiences create`](/docs/cli/commands/ads/audiences/create): Create a Meta custom audience
- [`smallforce ads audiences get`](/docs/cli/commands/ads/audiences/get): Read a Meta custom audience
- [`smallforce ads audiences update`](/docs/cli/commands/ads/audiences/update): Update a Meta custom audience
- [`smallforce ads audiences delete`](/docs/cli/commands/ads/audiences/delete): Delete a Meta custom audience
- [`smallforce ads audiences add-users`](/docs/cli/commands/ads/audiences/add-users): Add hashed customer records to a Meta custom audience

## Complete command help

```text
Usage: smallforce ads audiences [options] [command]

Manage Meta custom audiences

Options:
  -h, --help                      display help for command

Commands:
  list [options]                  List Meta custom audiences
  create [options]                Create a Meta custom audience
  get [options] <targetId>        Read a Meta custom audience
  update [options] <targetId>     Update a Meta custom audience
  delete [options] <targetId>     Delete a Meta custom audience
  add-users [options] <targetId>  Add hashed customer records to a Meta custom audience
  help [command]                  display help for command
```

## Related reference

- [`smallforce ads`](/docs/cli/commands/ads): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/audiences/list -->

# `smallforce ads audiences list`

List Meta custom audiences

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads audiences list --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads audiences list [options]

List Meta custom audiences

Options:
  --account <adAccountId>  Local id from ads accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads audiences`](/docs/cli/commands/ads/audiences): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/audiences/create -->

# `smallforce ads audiences create`

Create a Meta custom audience

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads audiences create --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads audiences create [options]

Create a Meta custom audience

Options:
  --account <adAccountId>  Local id from ads accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads audiences`](/docs/cli/commands/ads/audiences): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/audiences/get -->

# `smallforce ads audiences get`

Read a Meta custom audience

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads audiences get --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads audiences get [options] <targetId>

Read a Meta custom audience

Arguments:
  targetId                 SmallForce-local audience id; raw Meta ids are rejected

Options:
  --account <adAccountId>  Local id from ads accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads audiences`](/docs/cli/commands/ads/audiences): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/audiences/update -->

# `smallforce ads audiences update`

Update a Meta custom audience

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads audiences update --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads audiences update [options] <targetId>

Update a Meta custom audience

Arguments:
  targetId                 SmallForce-local audience id; raw Meta ids are rejected

Options:
  --account <adAccountId>  Local id from ads accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads audiences`](/docs/cli/commands/ads/audiences): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/audiences/delete -->

# `smallforce ads audiences delete`

Delete a Meta custom audience

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads audiences delete --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads audiences delete [options] <targetId>

Delete a Meta custom audience

Arguments:
  targetId                 SmallForce-local audience id; raw Meta ids are rejected

Options:
  --account <adAccountId>  Local id from ads accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads audiences`](/docs/cli/commands/ads/audiences): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/audiences/add-users -->

# `smallforce ads audiences add-users`

Add hashed customer records to a Meta custom audience

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads audiences add-users --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads audiences add-users [options] <targetId>

Add hashed customer records to a Meta custom audience

Arguments:
  targetId                 SmallForce-local audience id; raw Meta ids are rejected

Options:
  --account <adAccountId>  Local id from ads accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads audiences`](/docs/cli/commands/ads/audiences): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/conversions -->

# `smallforce ads conversions`

Inspect conversion quality and send Meta conversion events

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads conversions --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce ads conversions quality`](/docs/cli/commands/ads/conversions/quality): Read Meta conversion match quality
- [`smallforce ads conversions send`](/docs/cli/commands/ads/conversions/send): Send conversion events to Meta
- [`smallforce ads conversions destinations`](/docs/cli/commands/ads/conversions/destinations): List Meta conversion destinations

## Complete command help

```text
Usage: smallforce ads conversions [options] [command]

Inspect conversion quality and send Meta conversion events

Options:
  -h, --help                    display help for command

Commands:
  quality [options] <targetId>  Read Meta conversion match quality
  send [options] <targetId>     Send conversion events to Meta
  destinations [options]        List Meta conversion destinations
  help [command]                display help for command
```

## Related reference

- [`smallforce ads`](/docs/cli/commands/ads): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/conversions/quality -->

# `smallforce ads conversions quality`

Read Meta conversion match quality

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads conversions quality --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads conversions quality [options] <targetId>

Read Meta conversion match quality

Arguments:
  targetId                 SmallForce-local conversion-destination id; raw Meta ids are rejected

Options:
  --account <adAccountId>  Local id from ads accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads conversions`](/docs/cli/commands/ads/conversions): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/conversions/send -->

# `smallforce ads conversions send`

Send conversion events to Meta

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads conversions send --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads conversions send [options] <targetId>

Send conversion events to Meta

Arguments:
  targetId                 SmallForce-local conversion-destination id; raw Meta ids are rejected

Options:
  --account <adAccountId>  Local id from ads accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads conversions`](/docs/cli/commands/ads/conversions): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/conversions/destinations -->

# `smallforce ads conversions destinations`

List Meta conversion destinations

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads conversions destinations --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads conversions destinations [options]

List Meta conversion destinations

Options:
  --account <adAccountId>  Local id from ads accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads conversions`](/docs/cli/commands/ads/conversions): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/messaging -->

# `smallforce ads messaging`

Create Meta messaging, call, and WhatsApp advertisements

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads messaging --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce ads messaging create`](/docs/cli/commands/ads/messaging/create): Create a Meta messaging advertisement
- [`smallforce ads messaging call`](/docs/cli/commands/ads/messaging/call): Create a Meta call advertisement
- [`smallforce ads messaging whatsapp`](/docs/cli/commands/ads/messaging/whatsapp): Create a click-to-WhatsApp advertisement

## Complete command help

```text
Usage: smallforce ads messaging [options] [command]

Create Meta messaging, call, and WhatsApp advertisements

Options:
  -h, --help          display help for command

Commands:
  create [options]    Create a Meta messaging advertisement
  call [options]      Create a Meta call advertisement
  whatsapp [options]  Create a click-to-WhatsApp advertisement
  help [command]      display help for command
```

## Related reference

- [`smallforce ads`](/docs/cli/commands/ads): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/messaging/create -->

# `smallforce ads messaging create`

Create a Meta messaging advertisement

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads messaging create --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads messaging create [options]

Create a Meta messaging advertisement

Options:
  --account <adAccountId>  Local id from ads accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads messaging`](/docs/cli/commands/ads/messaging): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/messaging/call -->

# `smallforce ads messaging call`

Create a Meta call advertisement

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads messaging call --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads messaging call [options]

Create a Meta call advertisement

Options:
  --account <adAccountId>  Local id from ads accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads messaging`](/docs/cli/commands/ads/messaging): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/messaging/whatsapp -->

# `smallforce ads messaging whatsapp`

Create a click-to-WhatsApp advertisement

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads messaging whatsapp --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads messaging whatsapp [options]

Create a click-to-WhatsApp advertisement

Options:
  --account <adAccountId>  Local id from ads accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads messaging`](/docs/cli/commands/ads/messaging): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google -->

# `smallforce ads google`

Manage Google Ads through SmallForce-local, organization-scoped IDs

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce ads google connections`](/docs/cli/commands/ads/google/connections): Connect and activate Google Ads credentials
- [`smallforce ads google accounts`](/docs/cli/commands/ads/google/accounts): Synchronize and inspect Google Ads accounts
- [`smallforce ads google recommendations`](/docs/cli/commands/ads/google/recommendations): Review, apply and dismiss Google optimization recommendations
- [`smallforce ads google labels`](/docs/cli/commands/ads/google/labels): Label campaigns, ad groups, ads and keywords
- [`smallforce ads google custom-goals`](/docs/cli/commands/ads/google/custom-goals): Manage groups of conversion actions
- [`smallforce ads google asset-groups`](/docs/cli/commands/ads/google/asset-groups): Manage Performance Max assets and retail product groups
- [`smallforce ads google shared-budgets`](/docs/cli/commands/ads/google/shared-budgets): Create and inspect daily budgets shared by campaigns
- [`smallforce ads google manager-accounts`](/docs/cli/commands/ads/google/manager-accounts): Inspect and manage connected Google manager relationships
- [`smallforce ads google review`](/docs/cli/commands/ads/google/review): Inspect ad review and policy issues
- [`smallforce ads google activity`](/docs/cli/commands/ads/google/activity): Manage Google Ads activity
- [`smallforce ads google campaign-goals`](/docs/cli/commands/ads/google/campaign-goals): Override account goals on an individual campaign
- [`smallforce ads google conversion-goals`](/docs/cli/commands/ads/google/conversion-goals): Manage account conversion goals used for bidding
- [`smallforce ads google conversion-actions`](/docs/cli/commands/ads/google/conversion-actions): Edit conversion measurement and primary bidding actions
- [`smallforce ads google schedule`](/docs/cli/commands/ads/google/schedule): Manage Google Ads schedule
- [`smallforce ads google campaign-assets`](/docs/cli/commands/ads/google/campaign-assets): Manage Google Ads campaign-assets
- [`smallforce ads google ad-group-assets`](/docs/cli/commands/ads/google/ad-group-assets): Manage Google Ads ad-group-assets
- [`smallforce ads google callouts`](/docs/cli/commands/ads/google/callouts): Manage Google Ads callouts
- [`smallforce ads google sitelinks`](/docs/cli/commands/ads/google/sitelinks): Manage Google Ads sitelinks
- [`smallforce ads google structured-snippets`](/docs/cli/commands/ads/google/structured-snippets): Manage Google Ads structured-snippets
- [`smallforce ads google negative-keyword-lists`](/docs/cli/commands/ads/google/negative-keyword-lists): Manage Google Ads negative-keyword-lists
- [`smallforce ads google campaigns`](/docs/cli/commands/ads/google/campaigns): Inspect and manage Google Ads campaigns
- [`smallforce ads google bidding`](/docs/cli/commands/ads/google/bidding): Manage Google Ads bidding
- [`smallforce ads google keywords`](/docs/cli/commands/ads/google/keywords): Inspect keywords, search terms, and Keyword Planner data
- [`smallforce ads google ad-groups`](/docs/cli/commands/ads/google/ad-groups): Manage Google Ads ad groups
- [`smallforce ads google conversions`](/docs/cli/commands/ads/google/conversions): Manage conversion actions and send conversion events
- [`smallforce ads google advertisements`](/docs/cli/commands/ads/google/advertisements): Create and manage Google advertisements
- [`smallforce ads google insights`](/docs/cli/commands/ads/google/insights): Read timelines and run Google Ads Query Language queries
- [`smallforce ads google local-services`](/docs/cli/commands/ads/google/local-services): Read Google Local Services Ads leads and conversations
- [`smallforce ads google tracking`](/docs/cli/commands/ads/google/tracking): Read and update Google campaign URL tracking settings
- [`smallforce ads google targeting`](/docs/cli/commands/ads/google/targeting): Search Google Ads targeting options
- [`smallforce ads google audiences`](/docs/cli/commands/ads/google/audiences): Manage Google customer-list, website and lookalike audiences

## Complete command help

```text
Usage: smallforce ads google [options] [command]

Manage Google Ads through SmallForce-local, organization-scoped IDs

Options:
  -h, --help              display help for command

Commands:
  connections             Connect and activate Google Ads credentials
  accounts                Synchronize and inspect Google Ads accounts
  recommendations         Review, apply and dismiss Google optimization recommendations
  labels                  Label campaigns, ad groups, ads and keywords
  custom-goals            Manage groups of conversion actions
  asset-groups            Manage Performance Max assets and retail product groups
  shared-budgets          Create and inspect daily budgets shared by campaigns
  manager-accounts        Inspect and manage connected Google manager relationships
  review                  Inspect ad review and policy issues
  activity                Manage Google Ads activity
  campaign-goals          Override account goals on an individual campaign
  conversion-goals        Manage account conversion goals used for bidding
  conversion-actions      Edit conversion measurement and primary bidding actions
  schedule                Manage Google Ads schedule
  campaign-assets         Manage Google Ads campaign-assets
  ad-group-assets         Manage Google Ads ad-group-assets
  callouts                Manage Google Ads callouts
  sitelinks               Manage Google Ads sitelinks
  structured-snippets     Manage Google Ads structured-snippets
  negative-keyword-lists  Manage Google Ads negative-keyword-lists
  campaigns               Inspect and manage Google Ads campaigns
  bidding                 Manage Google Ads bidding
  keywords                Inspect keywords, search terms, and Keyword Planner data
  ad-groups               Manage Google Ads ad groups
  conversions             Manage conversion actions and send conversion events
  advertisements          Create and manage Google advertisements
  insights                Read timelines and run Google Ads Query Language queries
  local-services          Read Google Local Services Ads leads and conversations
  tracking                Read and update Google campaign URL tracking settings
  targeting               Search Google Ads targeting options
  audiences               Manage Google customer-list, website and lookalike audiences
  help [command]          display help for command
```

## Related reference

- [`smallforce ads`](/docs/cli/commands/ads): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/connections -->

# `smallforce ads google connections`

Connect and activate Google Ads credentials

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google connections --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce ads google connections connect`](/docs/cli/commands/ads/google/connections/connect): Create or reuse a managed Google Ads OAuth connection
- [`smallforce ads google connections list`](/docs/cli/commands/ads/google/connections/list): List Google Ads connections and activation state
- [`smallforce ads google connections activate`](/docs/cli/commands/ads/google/connections/activate): Activate billing for one Google Ads connection
- [`smallforce ads google connections disconnect`](/docs/cli/commands/ads/google/connections/disconnect): Disconnect one Google Ads credential

## Complete command help

```text
Usage: smallforce ads google connections [options] [command]

Connect and activate Google Ads credentials

Options:
  -h, --help                              display help for command

Commands:
  connect [options]                       Create or reuse a managed Google Ads OAuth connection
  list [options]                          List Google Ads connections and activation state
  activate [options] <socialAccountId>    Activate billing for one Google Ads connection
  disconnect [options] <socialAccountId>  Disconnect one Google Ads credential
  help [command]                          display help for command
```

## Related reference

- [`smallforce ads google`](/docs/cli/commands/ads/google): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/connections/connect -->

# `smallforce ads google connections connect`

Create or reuse a managed Google Ads OAuth connection

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google connections connect --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads google connections connect [options]

Create or reuse a managed Google Ads OAuth connection

Options:
  --profile <profileId>            Social profile id from social profiles list
  --provider-account <customerId>  Limit OAuth scope to one numeric Google Ads customer id;
                                   repeatable (default: [])
  --force                          Force a fresh Google authorization flow
  --api-key <key>                  SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>              SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                           Print stable machine-readable JSON
  --text                           Print human-readable text
  --format <format>                Output format: text or json
  -h, --help                       display help for command
```

## Related reference

- [`smallforce ads google connections`](/docs/cli/commands/ads/google/connections): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/connections/list -->

# `smallforce ads google connections list`

List Google Ads connections and activation state

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google connections list --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads google connections list [options]

List Google Ads connections and activation state

Options:
  --profile <profileId>  Filter by one social profile
  --include-deleted      Include disconnected connections
  --api-key <key>        SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>    SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                 Print stable machine-readable JSON
  --text                 Print human-readable text
  --format <format>      Output format: text or json
  -h, --help             display help for command
```

## Related reference

- [`smallforce ads google connections`](/docs/cli/commands/ads/google/connections): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/connections/activate -->

# `smallforce ads google connections activate`

Activate billing for one Google Ads connection

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google connections activate --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads google connections activate [options] <socialAccountId>

Activate billing for one Google Ads connection

Arguments:
  socialAccountId      Local connection id

Options:
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  -h, --help           display help for command
```

## Related reference

- [`smallforce ads google connections`](/docs/cli/commands/ads/google/connections): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/connections/disconnect -->

# `smallforce ads google connections disconnect`

Disconnect one Google Ads credential

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google connections disconnect --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads google connections disconnect [options] <socialAccountId>

Disconnect one Google Ads credential

Arguments:
  socialAccountId      Local connection id

Options:
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  -h, --help           display help for command
```

## Related reference

- [`smallforce ads google connections`](/docs/cli/commands/ads/google/connections): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/accounts -->

# `smallforce ads google accounts`

Synchronize and inspect Google Ads accounts

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google accounts --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce ads google accounts list`](/docs/cli/commands/ads/google/accounts/list): List local Google Ads account IDs
- [`smallforce ads google accounts sync`](/docs/cli/commands/ads/google/accounts/sync): Synchronize provider accounts for one Google Ads connection
- [`smallforce ads google accounts update`](/docs/cli/commands/ads/google/accounts/update): Update ad account

## Complete command help

```text
Usage: smallforce ads google accounts [options] [command]

Synchronize and inspect Google Ads accounts

Options:
  -h, --help                        display help for command

Commands:
  list [options]                    List local Google Ads account IDs
  sync [options] <socialAccountId>  Synchronize provider accounts for one Google Ads connection
  update [options]                  Update ad account
  help [command]                    display help for command
```

## Related reference

- [`smallforce ads google`](/docs/cli/commands/ads/google): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/accounts/list -->

# `smallforce ads google accounts list`

List local Google Ads account IDs

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google accounts list --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads google accounts list [options]

List local Google Ads account IDs

Options:
  --connection <socialAccountId>  Filter by one Google Ads connection
  --api-key <key>                 SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>             SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                          Print stable machine-readable JSON
  --text                          Print human-readable text
  --format <format>               Output format: text or json
  -h, --help                      display help for command
```

## Related reference

- [`smallforce ads google accounts`](/docs/cli/commands/ads/google/accounts): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/accounts/sync -->

# `smallforce ads google accounts sync`

Synchronize provider accounts for one Google Ads connection

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google accounts sync --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads google accounts sync [options] <socialAccountId>

Synchronize provider accounts for one Google Ads connection

Arguments:
  socialAccountId      Local connection id

Options:
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  -h, --help           display help for command
```

## Related reference

- [`smallforce ads google accounts`](/docs/cli/commands/ads/google/accounts): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/accounts/update -->

# `smallforce ads google accounts update`

Update ad account

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google accounts update --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads google accounts update [options]

Update ad account

Options:
  --account <adAccountId>  SmallForce-local Google Ads ad-account id from ads google accounts list
  --idempotency-key <key>  Stable mutation key; reuse after a timeout, never generate a new key for
                           an uncertain result
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads google accounts`](/docs/cli/commands/ads/google/accounts): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/recommendations -->

# `smallforce ads google recommendations`

Review, apply and dismiss Google optimization recommendations

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google recommendations --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce ads google recommendations apply`](/docs/cli/commands/ads/google/recommendations/apply): Apply google recommendations
- [`smallforce ads google recommendations dismiss`](/docs/cli/commands/ads/google/recommendations/dismiss): Dismiss google recommendations
- [`smallforce ads google recommendations list`](/docs/cli/commands/ads/google/recommendations/list): List google recommendations

## Complete command help

```text
Usage: smallforce ads google recommendations [options] [command]

Review, apply and dismiss Google optimization recommendations

Options:
  -h, --help         display help for command

Commands:
  apply [options]    Apply google recommendations
  dismiss [options]  Dismiss google recommendations
  list [options]     List google recommendations
  help [command]     display help for command
```

## Related reference

- [`smallforce ads google`](/docs/cli/commands/ads/google): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/recommendations/apply -->

# `smallforce ads google recommendations apply`

Apply google recommendations

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google recommendations apply --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads google recommendations apply [options]

Apply google recommendations

Options:
  --account <adAccountId>  SmallForce-local Google Ads ad-account id from ads google accounts list
  --idempotency-key <key>  Stable mutation key; reuse after a timeout, never generate a new key for
                           an uncertain result
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads google recommendations`](/docs/cli/commands/ads/google/recommendations): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/recommendations/dismiss -->

# `smallforce ads google recommendations dismiss`

Dismiss google recommendations

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google recommendations dismiss --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads google recommendations dismiss [options]

Dismiss google recommendations

Options:
  --account <adAccountId>  SmallForce-local Google Ads ad-account id from ads google accounts list
  --idempotency-key <key>  Stable mutation key; reuse after a timeout, never generate a new key for
                           an uncertain result
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads google recommendations`](/docs/cli/commands/ads/google/recommendations): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/recommendations/list -->

# `smallforce ads google recommendations list`

List google recommendations

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google recommendations list --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads google recommendations list [options]

List google recommendations

Options:
  --account <adAccountId>  SmallForce-local Google Ads ad-account id from ads google accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads google recommendations`](/docs/cli/commands/ads/google/recommendations): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/labels -->

# `smallforce ads google labels`

Label campaigns, ad groups, ads and keywords

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google labels --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce ads google labels attach`](/docs/cli/commands/ads/google/labels/attach): Attach ad label
- [`smallforce ads google labels create`](/docs/cli/commands/ads/google/labels/create): Create ad label
- [`smallforce ads google labels detach`](/docs/cli/commands/ads/google/labels/detach): Detach ad label
- [`smallforce ads google labels list`](/docs/cli/commands/ads/google/labels/list): List ad labels
- [`smallforce ads google labels remove`](/docs/cli/commands/ads/google/labels/remove): Remove ad label
- [`smallforce ads google labels update`](/docs/cli/commands/ads/google/labels/update): Update ad label

## Complete command help

```text
Usage: smallforce ads google labels [options] [command]

Label campaigns, ad groups, ads and keywords

Options:
  -h, --help                   display help for command

Commands:
  attach [options] <targetId>  Attach ad label
  create [options]             Create ad label
  detach [options] <targetId>  Detach ad label
  list [options]               List ad labels
  remove [options] <targetId>  Remove ad label
  update [options] <targetId>  Update ad label
  help [command]               display help for command
```

## Related reference

- [`smallforce ads google`](/docs/cli/commands/ads/google): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/labels/attach -->

# `smallforce ads google labels attach`

Attach ad label

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google labels attach --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads google labels attach [options] <targetId>

Attach ad label

Arguments:
  targetId                 SmallForce-local ad_label id; raw Google Ads ids are rejected

Options:
  --account <adAccountId>  SmallForce-local Google Ads ad-account id from ads google accounts list
  --idempotency-key <key>  Stable mutation key; reuse after a timeout, never generate a new key for
                           an uncertain result
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads google labels`](/docs/cli/commands/ads/google/labels): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/labels/create -->

# `smallforce ads google labels create`

Create ad label

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google labels create --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads google labels create [options]

Create ad label

Options:
  --account <adAccountId>  SmallForce-local Google Ads ad-account id from ads google accounts list
  --idempotency-key <key>  Stable mutation key; reuse after a timeout, never generate a new key for
                           an uncertain result
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads google labels`](/docs/cli/commands/ads/google/labels): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/labels/detach -->

# `smallforce ads google labels detach`

Detach ad label

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google labels detach --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads google labels detach [options] <targetId>

Detach ad label

Arguments:
  targetId                 SmallForce-local ad_label id; raw Google Ads ids are rejected

Options:
  --account <adAccountId>  SmallForce-local Google Ads ad-account id from ads google accounts list
  --idempotency-key <key>  Stable mutation key; reuse after a timeout, never generate a new key for
                           an uncertain result
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads google labels`](/docs/cli/commands/ads/google/labels): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/labels/list -->

# `smallforce ads google labels list`

List ad labels

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google labels list --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads google labels list [options]

List ad labels

Options:
  --account <adAccountId>  SmallForce-local Google Ads ad-account id from ads google accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads google labels`](/docs/cli/commands/ads/google/labels): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/labels/remove -->

# `smallforce ads google labels remove`

Remove ad label

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google labels remove --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads google labels remove [options] <targetId>

Remove ad label

Arguments:
  targetId                 SmallForce-local ad_label id; raw Google Ads ids are rejected

Options:
  --account <adAccountId>  SmallForce-local Google Ads ad-account id from ads google accounts list
  --idempotency-key <key>  Stable mutation key; reuse after a timeout, never generate a new key for
                           an uncertain result
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads google labels`](/docs/cli/commands/ads/google/labels): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/labels/update -->

# `smallforce ads google labels update`

Update ad label

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google labels update --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads google labels update [options] <targetId>

Update ad label

Arguments:
  targetId                 SmallForce-local ad_label id; raw Google Ads ids are rejected

Options:
  --account <adAccountId>  SmallForce-local Google Ads ad-account id from ads google accounts list
  --idempotency-key <key>  Stable mutation key; reuse after a timeout, never generate a new key for
                           an uncertain result
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads google labels`](/docs/cli/commands/ads/google/labels): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/custom-goals -->

# `smallforce ads google custom-goals`

Manage groups of conversion actions

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google custom-goals --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce ads google custom-goals create`](/docs/cli/commands/ads/google/custom-goals/create): Create custom conversion goal
- [`smallforce ads google custom-goals list`](/docs/cli/commands/ads/google/custom-goals/list): List custom conversion goals
- [`smallforce ads google custom-goals remove`](/docs/cli/commands/ads/google/custom-goals/remove): Remove custom conversion goal
- [`smallforce ads google custom-goals update`](/docs/cli/commands/ads/google/custom-goals/update): Update custom conversion goal

## Complete command help

```text
Usage: smallforce ads google custom-goals [options] [command]

Manage groups of conversion actions

Options:
  -h, --help                   display help for command

Commands:
  create [options]             Create custom conversion goal
  list [options]               List custom conversion goals
  remove [options] <targetId>  Remove custom conversion goal
  update [options] <targetId>  Update custom conversion goal
  help [command]               display help for command
```

## Related reference

- [`smallforce ads google`](/docs/cli/commands/ads/google): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/custom-goals/create -->

# `smallforce ads google custom-goals create`

Create custom conversion goal

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google custom-goals create --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads google custom-goals create [options]

Create custom conversion goal

Options:
  --account <adAccountId>  SmallForce-local Google Ads ad-account id from ads google accounts list
  --idempotency-key <key>  Stable mutation key; reuse after a timeout, never generate a new key for
                           an uncertain result
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads google custom-goals`](/docs/cli/commands/ads/google/custom-goals): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/custom-goals/list -->

# `smallforce ads google custom-goals list`

List custom conversion goals

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google custom-goals list --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads google custom-goals list [options]

List custom conversion goals

Options:
  --account <adAccountId>  SmallForce-local Google Ads ad-account id from ads google accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads google custom-goals`](/docs/cli/commands/ads/google/custom-goals): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/custom-goals/remove -->

# `smallforce ads google custom-goals remove`

Remove custom conversion goal

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google custom-goals remove --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads google custom-goals remove [options] <targetId>

Remove custom conversion goal

Arguments:
  targetId                 SmallForce-local conversion_goal id; raw Google Ads ids are rejected

Options:
  --account <adAccountId>  SmallForce-local Google Ads ad-account id from ads google accounts list
  --idempotency-key <key>  Stable mutation key; reuse after a timeout, never generate a new key for
                           an uncertain result
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads google custom-goals`](/docs/cli/commands/ads/google/custom-goals): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/custom-goals/update -->

# `smallforce ads google custom-goals update`

Update custom conversion goal

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google custom-goals update --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads google custom-goals update [options] <targetId>

Update custom conversion goal

Arguments:
  targetId                 SmallForce-local conversion_goal id; raw Google Ads ids are rejected

Options:
  --account <adAccountId>  SmallForce-local Google Ads ad-account id from ads google accounts list
  --idempotency-key <key>  Stable mutation key; reuse after a timeout, never generate a new key for
                           an uncertain result
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads google custom-goals`](/docs/cli/commands/ads/google/custom-goals): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/asset-groups -->

# `smallforce ads google asset-groups`

Manage Performance Max assets and retail product groups

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google asset-groups --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce ads google asset-groups create`](/docs/cli/commands/ads/google/asset-groups/create): Create google asset group
- [`smallforce ads google asset-groups edit-assets`](/docs/cli/commands/ads/google/asset-groups/edit-assets): Edit google asset group assets
- [`smallforce ads google asset-groups get`](/docs/cli/commands/ads/google/asset-groups/get): Get google asset group
- [`smallforce ads google asset-groups remove`](/docs/cli/commands/ads/google/asset-groups/remove): Remove google asset group
- [`smallforce ads google asset-groups replace-products`](/docs/cli/commands/ads/google/asset-groups/replace-products): Replace google listing group filters
- [`smallforce ads google asset-groups update`](/docs/cli/commands/ads/google/asset-groups/update): Update google asset group
- [`smallforce ads google asset-groups list`](/docs/cli/commands/ads/google/asset-groups/list): List Performance Max asset groups

## Complete command help

```text
Usage: smallforce ads google asset-groups [options] [command]

Manage Performance Max assets and retail product groups

Options:
  -h, --help                             display help for command

Commands:
  create [options] <targetId>            Create google asset group
  edit-assets [options] <targetId>       Edit google asset group assets
  get [options] <targetId>               Get google asset group
  remove [options] <targetId>            Remove google asset group
  replace-products [options] <targetId>  Replace google listing group filters
  update [options] <targetId>            Update google asset group
  list [options] <targetId>              List Performance Max asset groups
  help [command]                         display help for command
```

## Related reference

- [`smallforce ads google`](/docs/cli/commands/ads/google): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/asset-groups/create -->

# `smallforce ads google asset-groups create`

Create google asset group

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google asset-groups create --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads google asset-groups create [options] <targetId>

Create google asset group

Arguments:
  targetId                 SmallForce-local campaign id; raw Google Ads ids are rejected

Options:
  --account <adAccountId>  SmallForce-local Google Ads ad-account id from ads google accounts list
  --idempotency-key <key>  Stable mutation key; reuse after a timeout, never generate a new key for
                           an uncertain result
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads google asset-groups`](/docs/cli/commands/ads/google/asset-groups): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/asset-groups/edit-assets -->

# `smallforce ads google asset-groups edit-assets`

Edit google asset group assets

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google asset-groups edit-assets --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads google asset-groups edit-assets [options] <targetId>

Edit google asset group assets

Arguments:
  targetId                 SmallForce-local asset_group id; raw Google Ads ids are rejected

Options:
  --account <adAccountId>  SmallForce-local Google Ads ad-account id from ads google accounts list
  --idempotency-key <key>  Stable mutation key; reuse after a timeout, never generate a new key for
                           an uncertain result
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads google asset-groups`](/docs/cli/commands/ads/google/asset-groups): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/asset-groups/get -->

# `smallforce ads google asset-groups get`

Get google asset group

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google asset-groups get --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads google asset-groups get [options] <targetId>

Get google asset group

Arguments:
  targetId                 SmallForce-local asset_group id; raw Google Ads ids are rejected

Options:
  --account <adAccountId>  SmallForce-local Google Ads ad-account id from ads google accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads google asset-groups`](/docs/cli/commands/ads/google/asset-groups): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/asset-groups/remove -->

# `smallforce ads google asset-groups remove`

Remove google asset group

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google asset-groups remove --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads google asset-groups remove [options] <targetId>

Remove google asset group

Arguments:
  targetId                 SmallForce-local asset_group id; raw Google Ads ids are rejected

Options:
  --account <adAccountId>  SmallForce-local Google Ads ad-account id from ads google accounts list
  --idempotency-key <key>  Stable mutation key; reuse after a timeout, never generate a new key for
                           an uncertain result
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads google asset-groups`](/docs/cli/commands/ads/google/asset-groups): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/asset-groups/replace-products -->

# `smallforce ads google asset-groups replace-products`

Replace google listing group filters

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google asset-groups replace-products --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads google asset-groups replace-products [options] <targetId>

Replace google listing group filters

Arguments:
  targetId                 SmallForce-local asset_group id; raw Google Ads ids are rejected

Options:
  --account <adAccountId>  SmallForce-local Google Ads ad-account id from ads google accounts list
  --idempotency-key <key>  Stable mutation key; reuse after a timeout, never generate a new key for
                           an uncertain result
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads google asset-groups`](/docs/cli/commands/ads/google/asset-groups): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/asset-groups/update -->

# `smallforce ads google asset-groups update`

Update google asset group

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google asset-groups update --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads google asset-groups update [options] <targetId>

Update google asset group

Arguments:
  targetId                 SmallForce-local asset_group id; raw Google Ads ids are rejected

Options:
  --account <adAccountId>  SmallForce-local Google Ads ad-account id from ads google accounts list
  --idempotency-key <key>  Stable mutation key; reuse after a timeout, never generate a new key for
                           an uncertain result
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads google asset-groups`](/docs/cli/commands/ads/google/asset-groups): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/asset-groups/list -->

# `smallforce ads google asset-groups list`

List Performance Max asset groups

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google asset-groups list --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads google asset-groups list [options] <targetId>

List Performance Max asset groups

Arguments:
  targetId                 SmallForce-local campaign id; raw Google Ads ids are rejected

Options:
  --account <adAccountId>  SmallForce-local Google Ads ad-account id from ads google accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads google asset-groups`](/docs/cli/commands/ads/google/asset-groups): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/shared-budgets -->

# `smallforce ads google shared-budgets`

Create and inspect daily budgets shared by campaigns

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google shared-budgets --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce ads google shared-budgets create`](/docs/cli/commands/ads/google/shared-budgets/create): Create shared budget
- [`smallforce ads google shared-budgets list`](/docs/cli/commands/ads/google/shared-budgets/list): List shared budgets

## Complete command help

```text
Usage: smallforce ads google shared-budgets [options] [command]

Create and inspect daily budgets shared by campaigns

Options:
  -h, --help        display help for command

Commands:
  create [options]  Create shared budget
  list [options]    List shared budgets
  help [command]    display help for command
```

## Related reference

- [`smallforce ads google`](/docs/cli/commands/ads/google): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/shared-budgets/create -->

# `smallforce ads google shared-budgets create`

Create shared budget

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google shared-budgets create --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads google shared-budgets create [options]

Create shared budget

Options:
  --account <adAccountId>  SmallForce-local Google Ads ad-account id from ads google accounts list
  --idempotency-key <key>  Stable mutation key; reuse after a timeout, never generate a new key for
                           an uncertain result
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads google shared-budgets`](/docs/cli/commands/ads/google/shared-budgets): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/shared-budgets/list -->

# `smallforce ads google shared-budgets list`

List shared budgets

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google shared-budgets list --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads google shared-budgets list [options]

List shared budgets

Options:
  --account <adAccountId>  SmallForce-local Google Ads ad-account id from ads google accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads google shared-budgets`](/docs/cli/commands/ads/google/shared-budgets): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/manager-accounts -->

# `smallforce ads google manager-accounts`

Inspect and manage connected Google manager relationships

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google manager-accounts --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce ads google manager-accounts list`](/docs/cli/commands/ads/google/manager-accounts/list): Get ad account hierarchy
- [`smallforce ads google manager-accounts invite`](/docs/cli/commands/ads/google/manager-accounts/invite): Invite ad account to manager
- [`smallforce ads google manager-accounts update`](/docs/cli/commands/ads/google/manager-accounts/update): Update ad account manager link

## Complete command help

```text
Usage: smallforce ads google manager-accounts [options] [command]

Inspect and manage connected Google manager relationships

Options:
  -h, --help                   display help for command

Commands:
  list [options]               Get ad account hierarchy
  invite [options]             Invite ad account to manager
  update [options] <targetId>  Update ad account manager link
  help [command]               display help for command
```

## Related reference

- [`smallforce ads google`](/docs/cli/commands/ads/google): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/manager-accounts/list -->

# `smallforce ads google manager-accounts list`

Get ad account hierarchy

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google manager-accounts list --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads google manager-accounts list [options]

Get ad account hierarchy

Options:
  --account <adAccountId>  SmallForce-local Google Ads ad-account id from ads google accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads google manager-accounts`](/docs/cli/commands/ads/google/manager-accounts): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/manager-accounts/invite -->

# `smallforce ads google manager-accounts invite`

Invite ad account to manager

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google manager-accounts invite --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads google manager-accounts invite [options]

Invite ad account to manager

Options:
  --account <adAccountId>  SmallForce-local Google Ads ad-account id from ads google accounts list
  --idempotency-key <key>  Stable mutation key; reuse after a timeout, never generate a new key for
                           an uncertain result
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads google manager-accounts`](/docs/cli/commands/ads/google/manager-accounts): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/manager-accounts/update -->

# `smallforce ads google manager-accounts update`

Update ad account manager link

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google manager-accounts update --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads google manager-accounts update [options] <targetId>

Update ad account manager link

Arguments:
  targetId                 SmallForce-local manager_link id; raw Google Ads ids are rejected

Options:
  --account <adAccountId>  SmallForce-local Google Ads ad-account id from ads google accounts list
  --idempotency-key <key>  Stable mutation key; reuse after a timeout, never generate a new key for
                           an uncertain result
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads google manager-accounts`](/docs/cli/commands/ads/google/manager-accounts): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/review -->

# `smallforce ads google review`

Inspect ad review and policy issues

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google review --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce ads google review get`](/docs/cli/commands/ads/google/review/get): Get ad review

## Complete command help

```text
Usage: smallforce ads google review [options] [command]

Inspect ad review and policy issues

Options:
  -h, --help                display help for command

Commands:
  get [options] <targetId>  Get ad review
  help [command]            display help for command
```

## Related reference

- [`smallforce ads google`](/docs/cli/commands/ads/google): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/review/get -->

# `smallforce ads google review get`

Get ad review

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google review get --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads google review get [options] <targetId>

Get ad review

Arguments:
  targetId                 SmallForce-local ad id; raw Google Ads ids are rejected

Options:
  --account <adAccountId>  SmallForce-local Google Ads ad-account id from ads google accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads google review`](/docs/cli/commands/ads/google/review): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/activity -->

# `smallforce ads google activity`

Manage Google Ads activity

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google activity --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce ads google activity list`](/docs/cli/commands/ads/google/activity/list): Get ads activity log

## Complete command help

```text
Usage: smallforce ads google activity [options] [command]

Manage Google Ads activity

Options:
  -h, --help      display help for command

Commands:
  list [options]  Get ads activity log
  help [command]  display help for command
```

## Related reference

- [`smallforce ads google`](/docs/cli/commands/ads/google): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/activity/list -->

# `smallforce ads google activity list`

Get ads activity log

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google activity list --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads google activity list [options]

Get ads activity log

Options:
  --account <adAccountId>  SmallForce-local Google Ads ad-account id from ads google accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads google activity`](/docs/cli/commands/ads/google/activity): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/campaign-goals -->

# `smallforce ads google campaign-goals`

Override account goals on an individual campaign

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google campaign-goals --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce ads google campaign-goals get`](/docs/cli/commands/ads/google/campaign-goals/get): Get campaign conversion goals
- [`smallforce ads google campaign-goals update`](/docs/cli/commands/ads/google/campaign-goals/update): Update campaign conversion goals

## Complete command help

```text
Usage: smallforce ads google campaign-goals [options] [command]

Override account goals on an individual campaign

Options:
  -h, --help                   display help for command

Commands:
  get [options] <targetId>     Get campaign conversion goals
  update [options] <targetId>  Update campaign conversion goals
  help [command]               display help for command
```

## Related reference

- [`smallforce ads google`](/docs/cli/commands/ads/google): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/campaign-goals/get -->

# `smallforce ads google campaign-goals get`

Get campaign conversion goals

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google campaign-goals get --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads google campaign-goals get [options] <targetId>

Get campaign conversion goals

Arguments:
  targetId                 SmallForce-local campaign id; raw Google Ads ids are rejected

Options:
  --account <adAccountId>  SmallForce-local Google Ads ad-account id from ads google accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads google campaign-goals`](/docs/cli/commands/ads/google/campaign-goals): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/campaign-goals/update -->

# `smallforce ads google campaign-goals update`

Update campaign conversion goals

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google campaign-goals update --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads google campaign-goals update [options] <targetId>

Update campaign conversion goals

Arguments:
  targetId                 SmallForce-local campaign id; raw Google Ads ids are rejected

Options:
  --account <adAccountId>  SmallForce-local Google Ads ad-account id from ads google accounts list
  --idempotency-key <key>  Stable mutation key; reuse after a timeout, never generate a new key for
                           an uncertain result
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads google campaign-goals`](/docs/cli/commands/ads/google/campaign-goals): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/conversion-goals -->

# `smallforce ads google conversion-goals`

Manage account conversion goals used for bidding

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google conversion-goals --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce ads google conversion-goals list`](/docs/cli/commands/ads/google/conversion-goals/list): List ad conversion goals
- [`smallforce ads google conversion-goals update`](/docs/cli/commands/ads/google/conversion-goals/update): Update ad conversion goals

## Complete command help

```text
Usage: smallforce ads google conversion-goals [options] [command]

Manage account conversion goals used for bidding

Options:
  -h, --help        display help for command

Commands:
  list [options]    List ad conversion goals
  update [options]  Update ad conversion goals
  help [command]    display help for command
```

## Related reference

- [`smallforce ads google`](/docs/cli/commands/ads/google): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/conversion-goals/list -->

# `smallforce ads google conversion-goals list`

List ad conversion goals

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google conversion-goals list --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads google conversion-goals list [options]

List ad conversion goals

Options:
  --account <adAccountId>  SmallForce-local Google Ads ad-account id from ads google accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads google conversion-goals`](/docs/cli/commands/ads/google/conversion-goals): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/conversion-goals/update -->

# `smallforce ads google conversion-goals update`

Update ad conversion goals

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google conversion-goals update --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads google conversion-goals update [options]

Update ad conversion goals

Options:
  --account <adAccountId>  SmallForce-local Google Ads ad-account id from ads google accounts list
  --idempotency-key <key>  Stable mutation key; reuse after a timeout, never generate a new key for
                           an uncertain result
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads google conversion-goals`](/docs/cli/commands/ads/google/conversion-goals): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/conversion-actions -->

# `smallforce ads google conversion-actions`

Edit conversion measurement and primary bidding actions

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google conversion-actions --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce ads google conversion-actions update`](/docs/cli/commands/ads/google/conversion-actions/update): Update conversion action

## Complete command help

```text
Usage: smallforce ads google conversion-actions [options] [command]

Edit conversion measurement and primary bidding actions

Options:
  -h, --help                   display help for command

Commands:
  update [options] <targetId>  Update conversion action
  help [command]               display help for command
```

## Related reference

- [`smallforce ads google`](/docs/cli/commands/ads/google): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/conversion-actions/update -->

# `smallforce ads google conversion-actions update`

Update conversion action

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google conversion-actions update --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads google conversion-actions update [options] <targetId>

Update conversion action

Arguments:
  targetId                 SmallForce-local conversion_action id; raw Google Ads ids are rejected

Options:
  --account <adAccountId>  SmallForce-local Google Ads ad-account id from ads google accounts list
  --idempotency-key <key>  Stable mutation key; reuse after a timeout, never generate a new key for
                           an uncertain result
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads google conversion-actions`](/docs/cli/commands/ads/google/conversion-actions): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/schedule -->

# `smallforce ads google schedule`

Manage Google Ads schedule

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google schedule --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce ads google schedule get`](/docs/cli/commands/ads/google/schedule/get): Read a campaign's ad schedule (dayparting)
- [`smallforce ads google schedule replace`](/docs/cli/commands/ads/google/schedule/replace): Replace a campaign's ad schedule (dayparting)

## Complete command help

```text
Usage: smallforce ads google schedule [options] [command]

Manage Google Ads schedule

Options:
  -h, --help                    display help for command

Commands:
  get [options] <targetId>      Read a campaign's ad schedule (dayparting)
  replace [options] <targetId>  Replace a campaign's ad schedule (dayparting)
  help [command]                display help for command
```

## Related reference

- [`smallforce ads google`](/docs/cli/commands/ads/google): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/schedule/get -->

# `smallforce ads google schedule get`

Read a campaign's ad schedule (dayparting)

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google schedule get --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads google schedule get [options] <targetId>

Read a campaign's ad schedule (dayparting)

Arguments:
  targetId                 SmallForce-local campaign id; raw Google Ads ids are rejected

Options:
  --account <adAccountId>  SmallForce-local Google Ads ad-account id from ads google accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads google schedule`](/docs/cli/commands/ads/google/schedule): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/schedule/replace -->

# `smallforce ads google schedule replace`

Replace a campaign's ad schedule (dayparting)

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google schedule replace --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads google schedule replace [options] <targetId>

Replace a campaign's ad schedule (dayparting)

Arguments:
  targetId                 SmallForce-local campaign id; raw Google Ads ids are rejected

Options:
  --account <adAccountId>  SmallForce-local Google Ads ad-account id from ads google accounts list
  --idempotency-key <key>  Stable mutation key; reuse after a timeout, never generate a new key for
                           an uncertain result
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads google schedule`](/docs/cli/commands/ads/google/schedule): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/campaign-assets -->

# `smallforce ads google campaign-assets`

Manage Google Ads campaign-assets

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google campaign-assets --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce ads google campaign-assets list`](/docs/cli/commands/ads/google/campaign-assets/list): List campaign assets
- [`smallforce ads google campaign-assets update`](/docs/cli/commands/ads/google/campaign-assets/update): Update campaign assets
- [`smallforce ads google campaign-assets detach`](/docs/cli/commands/ads/google/campaign-assets/detach): Remove campaign assets

## Complete command help

```text
Usage: smallforce ads google campaign-assets [options] [command]

Manage Google Ads campaign-assets

Options:
  -h, --help                   display help for command

Commands:
  list [options] <targetId>    List campaign assets
  update [options] <targetId>  Update campaign assets
  detach [options] <targetId>  Remove campaign assets
  help [command]               display help for command
```

## Related reference

- [`smallforce ads google`](/docs/cli/commands/ads/google): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/campaign-assets/list -->

# `smallforce ads google campaign-assets list`

List campaign assets

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google campaign-assets list --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads google campaign-assets list [options] <targetId>

List campaign assets

Arguments:
  targetId                 SmallForce-local campaign id; raw Google Ads ids are rejected

Options:
  --account <adAccountId>  SmallForce-local Google Ads ad-account id from ads google accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads google campaign-assets`](/docs/cli/commands/ads/google/campaign-assets): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/campaign-assets/update -->

# `smallforce ads google campaign-assets update`

Update campaign assets

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google campaign-assets update --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads google campaign-assets update [options] <targetId>

Update campaign assets

Arguments:
  targetId                 SmallForce-local campaign id; raw Google Ads ids are rejected

Options:
  --account <adAccountId>  SmallForce-local Google Ads ad-account id from ads google accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads google campaign-assets`](/docs/cli/commands/ads/google/campaign-assets): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/campaign-assets/detach -->

# `smallforce ads google campaign-assets detach`

Remove campaign assets

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google campaign-assets detach --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads google campaign-assets detach [options] <targetId>

Remove campaign assets

Arguments:
  targetId                 SmallForce-local campaign id; raw Google Ads ids are rejected

Options:
  --account <adAccountId>  SmallForce-local Google Ads ad-account id from ads google accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads google campaign-assets`](/docs/cli/commands/ads/google/campaign-assets): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/ad-group-assets -->

# `smallforce ads google ad-group-assets`

Manage Google Ads ad-group-assets

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google ad-group-assets --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce ads google ad-group-assets list`](/docs/cli/commands/ads/google/ad-group-assets/list): List ad-group assets
- [`smallforce ads google ad-group-assets attach`](/docs/cli/commands/ads/google/ad-group-assets/attach): Attach ad-group assets
- [`smallforce ads google ad-group-assets update`](/docs/cli/commands/ads/google/ad-group-assets/update): Update ad-group assets
- [`smallforce ads google ad-group-assets detach`](/docs/cli/commands/ads/google/ad-group-assets/detach): Remove ad-group assets

## Complete command help

```text
Usage: smallforce ads google ad-group-assets [options] [command]

Manage Google Ads ad-group-assets

Options:
  -h, --help                   display help for command

Commands:
  list [options] <targetId>    List ad-group assets
  attach [options] <targetId>  Attach ad-group assets
  update [options] <targetId>  Update ad-group assets
  detach [options] <targetId>  Remove ad-group assets
  help [command]               display help for command
```

## Related reference

- [`smallforce ads google`](/docs/cli/commands/ads/google): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/ad-group-assets/list -->

# `smallforce ads google ad-group-assets list`

List ad-group assets

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google ad-group-assets list --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads google ad-group-assets list [options] <targetId>

List ad-group assets

Arguments:
  targetId                 SmallForce-local ad_set id; raw Google Ads ids are rejected

Options:
  --account <adAccountId>  SmallForce-local Google Ads ad-account id from ads google accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads google ad-group-assets`](/docs/cli/commands/ads/google/ad-group-assets): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/ad-group-assets/attach -->

# `smallforce ads google ad-group-assets attach`

Attach ad-group assets

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google ad-group-assets attach --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads google ad-group-assets attach [options] <targetId>

Attach ad-group assets

Arguments:
  targetId                 SmallForce-local ad_set id; raw Google Ads ids are rejected

Options:
  --account <adAccountId>  SmallForce-local Google Ads ad-account id from ads google accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads google ad-group-assets`](/docs/cli/commands/ads/google/ad-group-assets): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/ad-group-assets/update -->

# `smallforce ads google ad-group-assets update`

Update ad-group assets

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google ad-group-assets update --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads google ad-group-assets update [options] <targetId>

Update ad-group assets

Arguments:
  targetId                 SmallForce-local ad_set id; raw Google Ads ids are rejected

Options:
  --account <adAccountId>  SmallForce-local Google Ads ad-account id from ads google accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads google ad-group-assets`](/docs/cli/commands/ads/google/ad-group-assets): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/ad-group-assets/detach -->

# `smallforce ads google ad-group-assets detach`

Remove ad-group assets

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google ad-group-assets detach --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads google ad-group-assets detach [options] <targetId>

Remove ad-group assets

Arguments:
  targetId                 SmallForce-local ad_set id; raw Google Ads ids are rejected

Options:
  --account <adAccountId>  SmallForce-local Google Ads ad-account id from ads google accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads google ad-group-assets`](/docs/cli/commands/ads/google/ad-group-assets): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/callouts -->

# `smallforce ads google callouts`

Manage Google Ads callouts

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google callouts --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce ads google callouts update`](/docs/cli/commands/ads/google/callouts/update): Update account callouts
- [`smallforce ads google callouts list`](/docs/cli/commands/ads/google/callouts/list): List account-wide callout extensions
- [`smallforce ads google callouts add`](/docs/cli/commands/ads/google/callouts/add): Add account-wide callout extensions
- [`smallforce ads google callouts remove`](/docs/cli/commands/ads/google/callouts/remove): Remove an account-wide callout attachment

## Complete command help

```text
Usage: smallforce ads google callouts [options] [command]

Manage Google Ads callouts

Options:
  -h, --help                   display help for command

Commands:
  update [options]             Update account callouts
  list [options]               List account-wide callout extensions
  add [options]                Add account-wide callout extensions
  remove [options] <targetId>  Remove an account-wide callout attachment
  help [command]               display help for command
```

## Related reference

- [`smallforce ads google`](/docs/cli/commands/ads/google): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/callouts/update -->

# `smallforce ads google callouts update`

Update account callouts

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google callouts update --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads google callouts update [options]

Update account callouts

Options:
  --account <adAccountId>  SmallForce-local Google Ads ad-account id from ads google accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads google callouts`](/docs/cli/commands/ads/google/callouts): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/callouts/list -->

# `smallforce ads google callouts list`

List account-wide callout extensions

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google callouts list --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads google callouts list [options]

List account-wide callout extensions

Options:
  --account <adAccountId>  SmallForce-local Google Ads ad-account id from ads google accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads google callouts`](/docs/cli/commands/ads/google/callouts): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/callouts/add -->

# `smallforce ads google callouts add`

Add account-wide callout extensions

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google callouts add --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads google callouts add [options]

Add account-wide callout extensions

Options:
  --account <adAccountId>  SmallForce-local Google Ads ad-account id from ads google accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads google callouts`](/docs/cli/commands/ads/google/callouts): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/callouts/remove -->

# `smallforce ads google callouts remove`

Remove an account-wide callout attachment

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google callouts remove --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads google callouts remove [options] <targetId>

Remove an account-wide callout attachment

Arguments:
  targetId                 SmallForce-local google_asset id; raw Google Ads ids are rejected

Options:
  --account <adAccountId>  SmallForce-local Google Ads ad-account id from ads google accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads google callouts`](/docs/cli/commands/ads/google/callouts): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/sitelinks -->

# `smallforce ads google sitelinks`

Manage Google Ads sitelinks

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google sitelinks --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce ads google sitelinks list`](/docs/cli/commands/ads/google/sitelinks/list): List account sitelinks
- [`smallforce ads google sitelinks add`](/docs/cli/commands/ads/google/sitelinks/add): Add account sitelinks
- [`smallforce ads google sitelinks update`](/docs/cli/commands/ads/google/sitelinks/update): Update account sitelinks
- [`smallforce ads google sitelinks detach`](/docs/cli/commands/ads/google/sitelinks/detach): Remove account sitelink

## Complete command help

```text
Usage: smallforce ads google sitelinks [options] [command]

Manage Google Ads sitelinks

Options:
  -h, --help        display help for command

Commands:
  list [options]    List account sitelinks
  add [options]     Add account sitelinks
  update [options]  Update account sitelinks
  detach [options]  Remove account sitelink
  help [command]    display help for command
```

## Related reference

- [`smallforce ads google`](/docs/cli/commands/ads/google): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/sitelinks/list -->

# `smallforce ads google sitelinks list`

List account sitelinks

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google sitelinks list --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads google sitelinks list [options]

List account sitelinks

Options:
  --account <adAccountId>  SmallForce-local Google Ads ad-account id from ads google accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads google sitelinks`](/docs/cli/commands/ads/google/sitelinks): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/sitelinks/add -->

# `smallforce ads google sitelinks add`

Add account sitelinks

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google sitelinks add --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads google sitelinks add [options]

Add account sitelinks

Options:
  --account <adAccountId>  SmallForce-local Google Ads ad-account id from ads google accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads google sitelinks`](/docs/cli/commands/ads/google/sitelinks): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/sitelinks/update -->

# `smallforce ads google sitelinks update`

Update account sitelinks

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google sitelinks update --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads google sitelinks update [options]

Update account sitelinks

Options:
  --account <adAccountId>  SmallForce-local Google Ads ad-account id from ads google accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads google sitelinks`](/docs/cli/commands/ads/google/sitelinks): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/sitelinks/detach -->

# `smallforce ads google sitelinks detach`

Remove account sitelink

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google sitelinks detach --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads google sitelinks detach [options]

Remove account sitelink

Options:
  --account <adAccountId>  SmallForce-local Google Ads ad-account id from ads google accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads google sitelinks`](/docs/cli/commands/ads/google/sitelinks): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/structured-snippets -->

# `smallforce ads google structured-snippets`

Manage Google Ads structured-snippets

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google structured-snippets --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce ads google structured-snippets list`](/docs/cli/commands/ads/google/structured-snippets/list): List account snippets
- [`smallforce ads google structured-snippets add`](/docs/cli/commands/ads/google/structured-snippets/add): Add account snippets
- [`smallforce ads google structured-snippets update`](/docs/cli/commands/ads/google/structured-snippets/update): Update account snippets
- [`smallforce ads google structured-snippets detach`](/docs/cli/commands/ads/google/structured-snippets/detach): Remove account snippet

## Complete command help

```text
Usage: smallforce ads google structured-snippets [options] [command]

Manage Google Ads structured-snippets

Options:
  -h, --help        display help for command

Commands:
  list [options]    List account snippets
  add [options]     Add account snippets
  update [options]  Update account snippets
  detach [options]  Remove account snippet
  help [command]    display help for command
```

## Related reference

- [`smallforce ads google`](/docs/cli/commands/ads/google): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/structured-snippets/list -->

# `smallforce ads google structured-snippets list`

List account snippets

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google structured-snippets list --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads google structured-snippets list [options]

List account snippets

Options:
  --account <adAccountId>  SmallForce-local Google Ads ad-account id from ads google accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads google structured-snippets`](/docs/cli/commands/ads/google/structured-snippets): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/structured-snippets/add -->

# `smallforce ads google structured-snippets add`

Add account snippets

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google structured-snippets add --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads google structured-snippets add [options]

Add account snippets

Options:
  --account <adAccountId>  SmallForce-local Google Ads ad-account id from ads google accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads google structured-snippets`](/docs/cli/commands/ads/google/structured-snippets): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/structured-snippets/update -->

# `smallforce ads google structured-snippets update`

Update account snippets

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google structured-snippets update --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads google structured-snippets update [options]

Update account snippets

Options:
  --account <adAccountId>  SmallForce-local Google Ads ad-account id from ads google accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads google structured-snippets`](/docs/cli/commands/ads/google/structured-snippets): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/structured-snippets/detach -->

# `smallforce ads google structured-snippets detach`

Remove account snippet

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google structured-snippets detach --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads google structured-snippets detach [options]

Remove account snippet

Options:
  --account <adAccountId>  SmallForce-local Google Ads ad-account id from ads google accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads google structured-snippets`](/docs/cli/commands/ads/google/structured-snippets): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/negative-keyword-lists -->

# `smallforce ads google negative-keyword-lists`

Manage Google Ads negative-keyword-lists

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google negative-keyword-lists --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce ads google negative-keyword-lists list`](/docs/cli/commands/ads/google/negative-keyword-lists/list): List shared negative keyword lists
- [`smallforce ads google negative-keyword-lists create`](/docs/cli/commands/ads/google/negative-keyword-lists/create): Create a shared negative keyword list, initially unattached
- [`smallforce ads google negative-keyword-lists get`](/docs/cli/commands/ads/google/negative-keyword-lists/get): Read a shared list and its keywords
- [`smallforce ads google negative-keyword-lists rename`](/docs/cli/commands/ads/google/negative-keyword-lists/rename): Rename a shared negative keyword list
- [`smallforce ads google negative-keyword-lists delete`](/docs/cli/commands/ads/google/negative-keyword-lists/delete): Delete a shared list after detaching it from all campaigns
- [`smallforce ads google negative-keyword-lists replace-keywords`](/docs/cli/commands/ads/google/negative-keyword-lists/replace-keywords): Replace all keywords in a shared list; affects every attached campaign

## Complete command help

```text
Usage: smallforce ads google negative-keyword-lists [options] [command]

Manage Google Ads negative-keyword-lists

Options:
  -h, --help                             display help for command

Commands:
  list [options]                         List shared negative keyword lists
  create [options]                       Create a shared negative keyword list, initially unattached
  get [options] <targetId>               Read a shared list and its keywords
  rename [options] <targetId>            Rename a shared negative keyword list
  delete [options] <targetId>            Delete a shared list after detaching it from all campaigns
  replace-keywords [options] <targetId>  Replace all keywords in a shared list; affects every
                                         attached campaign
  help [command]                         display help for command
```

## Related reference

- [`smallforce ads google`](/docs/cli/commands/ads/google): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/negative-keyword-lists/list -->

# `smallforce ads google negative-keyword-lists list`

List shared negative keyword lists

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google negative-keyword-lists list --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads google negative-keyword-lists list [options]

List shared negative keyword lists

Options:
  --account <adAccountId>  SmallForce-local Google Ads ad-account id from ads google accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads google negative-keyword-lists`](/docs/cli/commands/ads/google/negative-keyword-lists): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/negative-keyword-lists/create -->

# `smallforce ads google negative-keyword-lists create`

Create a shared negative keyword list, initially unattached

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google negative-keyword-lists create --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads google negative-keyword-lists create [options]

Create a shared negative keyword list, initially unattached

Options:
  --account <adAccountId>  SmallForce-local Google Ads ad-account id from ads google accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads google negative-keyword-lists`](/docs/cli/commands/ads/google/negative-keyword-lists): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/negative-keyword-lists/get -->

# `smallforce ads google negative-keyword-lists get`

Read a shared list and its keywords

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google negative-keyword-lists get --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads google negative-keyword-lists get [options] <targetId>

Read a shared list and its keywords

Arguments:
  targetId                 SmallForce-local negative_keyword_list id; raw Google Ads ids are
                           rejected

Options:
  --account <adAccountId>  SmallForce-local Google Ads ad-account id from ads google accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads google negative-keyword-lists`](/docs/cli/commands/ads/google/negative-keyword-lists): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/negative-keyword-lists/rename -->

# `smallforce ads google negative-keyword-lists rename`

Rename a shared negative keyword list

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google negative-keyword-lists rename --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads google negative-keyword-lists rename [options] <targetId>

Rename a shared negative keyword list

Arguments:
  targetId                 SmallForce-local negative_keyword_list id; raw Google Ads ids are
                           rejected

Options:
  --account <adAccountId>  SmallForce-local Google Ads ad-account id from ads google accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads google negative-keyword-lists`](/docs/cli/commands/ads/google/negative-keyword-lists): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/negative-keyword-lists/delete -->

# `smallforce ads google negative-keyword-lists delete`

Delete a shared list after detaching it from all campaigns

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google negative-keyword-lists delete --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads google negative-keyword-lists delete [options] <targetId>

Delete a shared list after detaching it from all campaigns

Arguments:
  targetId                 SmallForce-local negative_keyword_list id; raw Google Ads ids are
                           rejected

Options:
  --account <adAccountId>  SmallForce-local Google Ads ad-account id from ads google accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads google negative-keyword-lists`](/docs/cli/commands/ads/google/negative-keyword-lists): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/negative-keyword-lists/replace-keywords -->

# `smallforce ads google negative-keyword-lists replace-keywords`

Replace all keywords in a shared list; affects every attached campaign

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google negative-keyword-lists replace-keywords --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads google negative-keyword-lists replace-keywords [options] <targetId>

Replace all keywords in a shared list; affects every attached campaign

Arguments:
  targetId                 SmallForce-local negative_keyword_list id; raw Google Ads ids are
                           rejected

Options:
  --account <adAccountId>  SmallForce-local Google Ads ad-account id from ads google accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads google negative-keyword-lists`](/docs/cli/commands/ads/google/negative-keyword-lists): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/campaigns -->

# `smallforce ads google campaigns`

Inspect and manage Google Ads campaigns

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google campaigns --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce ads google campaigns negative-keyword-lists`](/docs/cli/commands/ads/google/campaigns/negative-keyword-lists): List shared negative keyword lists attached to a campaign
- [`smallforce ads google campaigns replace-negative-keyword-lists`](/docs/cli/commands/ads/google/campaigns/replace-negative-keyword-lists): Replace all shared negative keyword list links; an empty array detaches all
- [`smallforce ads google campaigns bidding`](/docs/cli/commands/ads/google/campaigns/bidding): Read campaign bidding and optimization
- [`smallforce ads google campaigns negative-keywords`](/docs/cli/commands/ads/google/campaigns/negative-keywords): List campaign negative keywords
- [`smallforce ads google campaigns replace-negative-keywords`](/docs/cli/commands/ads/google/campaigns/replace-negative-keywords): Replace the complete campaign negative keyword set
- [`smallforce ads google campaigns targeting`](/docs/cli/commands/ads/google/campaigns/targeting): Read device, location and language targeting
- [`smallforce ads google campaigns update-targeting`](/docs/cli/commands/ads/google/campaigns/update-targeting): Replace supplied device, location or language targeting
- [`smallforce ads google campaigns create`](/docs/cli/commands/ads/google/campaigns/create): Create a paused Google campaign shell
- [`smallforce ads google campaigns list`](/docs/cli/commands/ads/google/campaigns/list): List Google Ads campaigns
- [`smallforce ads google campaigns status`](/docs/cli/commands/ads/google/campaigns/status): Pause or resume a Google Ads campaign
- [`smallforce ads google campaigns update`](/docs/cli/commands/ads/google/campaigns/update): Update Google Ads campaign bidding
- [`smallforce ads google campaigns delete`](/docs/cli/commands/ads/google/campaigns/delete): Delete a Google Ads campaign
- [`smallforce ads google campaigns bulk-status`](/docs/cli/commands/ads/google/campaigns/bulk-status): Pause or resume several Google Ads campaigns
- [`smallforce ads google campaigns tree`](/docs/cli/commands/ads/google/campaigns/tree): Read the Google Ads campaign tree
- [`smallforce ads google campaigns attach-assets`](/docs/cli/commands/ads/google/campaigns/attach-assets): Attach Google sitelinks, callouts, or structured snippets to a campaign
- [`smallforce ads google campaigns analytics`](/docs/cli/commands/ads/google/campaigns/analytics): Read Google Ads campaign analytics
- [`smallforce ads google campaigns create-paused`](/docs/cli/commands/ads/google/campaigns/create-paused): Create a paused Google Search or Performance Max campaign

## Complete command help

```text
Usage: smallforce ads google campaigns [options] [command]

Inspect and manage Google Ads campaigns

Options:
  -h, --help                                           display help for command

Commands:
  negative-keyword-lists [options] <targetId>          List shared negative keyword lists attached
                                                       to a campaign
  replace-negative-keyword-lists [options] <targetId>  Replace all shared negative keyword list
                                                       links; an empty array detaches all
  bidding [options] <targetId>                         Read campaign bidding and optimization
  negative-keywords [options] <targetId>               List campaign negative keywords
  replace-negative-keywords [options] <targetId>       Replace the complete campaign negative
                                                       keyword set
  targeting [options] <targetId>                       Read device, location and language targeting
  update-targeting [options] <targetId>                Replace supplied device, location or language
                                                       targeting
  create [options]                                     Create a paused Google campaign shell
  list [options]                                       List Google Ads campaigns
  status [options] <targetId>                          Pause or resume a Google Ads campaign
  update [options] <targetId>                          Update Google Ads campaign bidding
  delete [options] <targetId>                          Delete a Google Ads campaign
  bulk-status [options]                                Pause or resume several Google Ads campaigns
  tree [options]                                       Read the Google Ads campaign tree
  attach-assets [options] <targetId>                   Attach Google sitelinks, callouts, or
                                                       structured snippets to a campaign
  analytics [options] <targetId>                       Read Google Ads campaign analytics
  create-paused [options]                              Create a paused Google Search or Performance
                                                       Max campaign
  help [command]                                       display help for command
```

## Related reference

- [`smallforce ads google`](/docs/cli/commands/ads/google): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/campaigns/negative-keyword-lists -->

# `smallforce ads google campaigns negative-keyword-lists`

List shared negative keyword lists attached to a campaign

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google campaigns negative-keyword-lists --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads google campaigns negative-keyword-lists [options] <targetId>

List shared negative keyword lists attached to a campaign

Arguments:
  targetId                 SmallForce-local campaign id; raw Google Ads ids are rejected

Options:
  --account <adAccountId>  SmallForce-local Google Ads ad-account id from ads google accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads google campaigns`](/docs/cli/commands/ads/google/campaigns): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/campaigns/replace-negative-keyword-lists -->

# `smallforce ads google campaigns replace-negative-keyword-lists`

Replace all shared negative keyword list links; an empty array detaches all

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google campaigns replace-negative-keyword-lists --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads google campaigns replace-negative-keyword-lists [options] <targetId>

Replace all shared negative keyword list links; an empty array detaches all

Arguments:
  targetId                 SmallForce-local campaign id; raw Google Ads ids are rejected

Options:
  --account <adAccountId>  SmallForce-local Google Ads ad-account id from ads google accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads google campaigns`](/docs/cli/commands/ads/google/campaigns): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/campaigns/bidding -->

# `smallforce ads google campaigns bidding`

Read campaign bidding and optimization

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google campaigns bidding --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads google campaigns bidding [options] <targetId>

Read campaign bidding and optimization

Arguments:
  targetId                 SmallForce-local campaign id; raw Google Ads ids are rejected

Options:
  --account <adAccountId>  SmallForce-local Google Ads ad-account id from ads google accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads google campaigns`](/docs/cli/commands/ads/google/campaigns): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/campaigns/negative-keywords -->

# `smallforce ads google campaigns negative-keywords`

List campaign negative keywords

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google campaigns negative-keywords --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads google campaigns negative-keywords [options] <targetId>

List campaign negative keywords

Arguments:
  targetId                 SmallForce-local campaign id; raw Google Ads ids are rejected

Options:
  --account <adAccountId>  SmallForce-local Google Ads ad-account id from ads google accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads google campaigns`](/docs/cli/commands/ads/google/campaigns): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/campaigns/replace-negative-keywords -->

# `smallforce ads google campaigns replace-negative-keywords`

Replace the complete campaign negative keyword set

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google campaigns replace-negative-keywords --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads google campaigns replace-negative-keywords [options] <targetId>

Replace the complete campaign negative keyword set

Arguments:
  targetId                 SmallForce-local campaign id; raw Google Ads ids are rejected

Options:
  --account <adAccountId>  SmallForce-local Google Ads ad-account id from ads google accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads google campaigns`](/docs/cli/commands/ads/google/campaigns): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/campaigns/targeting -->

# `smallforce ads google campaigns targeting`

Read device, location and language targeting

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google campaigns targeting --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads google campaigns targeting [options] <targetId>

Read device, location and language targeting

Arguments:
  targetId                 SmallForce-local campaign id; raw Google Ads ids are rejected

Options:
  --account <adAccountId>  SmallForce-local Google Ads ad-account id from ads google accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads google campaigns`](/docs/cli/commands/ads/google/campaigns): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/campaigns/update-targeting -->

# `smallforce ads google campaigns update-targeting`

Replace supplied device, location or language targeting

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google campaigns update-targeting --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads google campaigns update-targeting [options] <targetId>

Replace supplied device, location or language targeting

Arguments:
  targetId                 SmallForce-local campaign id; raw Google Ads ids are rejected

Options:
  --account <adAccountId>  SmallForce-local Google Ads ad-account id from ads google accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads google campaigns`](/docs/cli/commands/ads/google/campaigns): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/campaigns/create -->

# `smallforce ads google campaigns create`

Create a paused Google campaign shell

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google campaigns create --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads google campaigns create [options]

Create a paused Google campaign shell

Options:
  --account <adAccountId>  SmallForce-local Google Ads ad-account id from ads google accounts list
  --idempotency-key <key>  Stable mutation key; reuse after a timeout, never generate a new key for
                           an uncertain result
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads google campaigns`](/docs/cli/commands/ads/google/campaigns): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/campaigns/list -->

# `smallforce ads google campaigns list`

List Google Ads campaigns

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google campaigns list --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads google campaigns list [options]

List Google Ads campaigns

Options:
  --account <adAccountId>  SmallForce-local Google Ads ad-account id from ads google accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads google campaigns`](/docs/cli/commands/ads/google/campaigns): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/campaigns/status -->

# `smallforce ads google campaigns status`

Pause or resume a Google Ads campaign

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google campaigns status --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads google campaigns status [options] <targetId>

Pause or resume a Google Ads campaign

Arguments:
  targetId                 SmallForce-local campaign id; raw Google Ads ids are rejected

Options:
  --account <adAccountId>  SmallForce-local Google Ads ad-account id from ads google accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads google campaigns`](/docs/cli/commands/ads/google/campaigns): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/campaigns/update -->

# `smallforce ads google campaigns update`

Update Google Ads campaign bidding

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google campaigns update --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads google campaigns update [options] <targetId>

Update Google Ads campaign bidding

Arguments:
  targetId                 SmallForce-local campaign id; raw Google Ads ids are rejected

Options:
  --account <adAccountId>  SmallForce-local Google Ads ad-account id from ads google accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads google campaigns`](/docs/cli/commands/ads/google/campaigns): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/campaigns/delete -->

# `smallforce ads google campaigns delete`

Delete a Google Ads campaign

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google campaigns delete --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads google campaigns delete [options] <targetId>

Delete a Google Ads campaign

Arguments:
  targetId                 SmallForce-local campaign id; raw Google Ads ids are rejected

Options:
  --account <adAccountId>  SmallForce-local Google Ads ad-account id from ads google accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads google campaigns`](/docs/cli/commands/ads/google/campaigns): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/campaigns/bulk-status -->

# `smallforce ads google campaigns bulk-status`

Pause or resume several Google Ads campaigns

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google campaigns bulk-status --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads google campaigns bulk-status [options]

Pause or resume several Google Ads campaigns

Options:
  --account <adAccountId>  SmallForce-local Google Ads ad-account id from ads google accounts list
  --campaign <campaignId>  SmallForce-local campaign id; repeat for multiple campaigns (default: [])
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads google campaigns`](/docs/cli/commands/ads/google/campaigns): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/campaigns/tree -->

# `smallforce ads google campaigns tree`

Read the Google Ads campaign tree

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google campaigns tree --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads google campaigns tree [options]

Read the Google Ads campaign tree

Options:
  --account <adAccountId>  SmallForce-local Google Ads ad-account id from ads google accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads google campaigns`](/docs/cli/commands/ads/google/campaigns): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/campaigns/attach-assets -->

# `smallforce ads google campaigns attach-assets`

Attach Google sitelinks, callouts, or structured snippets to a campaign

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google campaigns attach-assets --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads google campaigns attach-assets [options] <targetId>

Attach Google sitelinks, callouts, or structured snippets to a campaign

Arguments:
  targetId                 SmallForce-local campaign id; raw Google Ads ids are rejected

Options:
  --account <adAccountId>  SmallForce-local Google Ads ad-account id from ads google accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads google campaigns`](/docs/cli/commands/ads/google/campaigns): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/campaigns/analytics -->

# `smallforce ads google campaigns analytics`

Read Google Ads campaign analytics

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google campaigns analytics --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads google campaigns analytics [options] <targetId>

Read Google Ads campaign analytics

Arguments:
  targetId                 SmallForce-local campaign id; raw Google Ads ids are rejected

Options:
  --account <adAccountId>  SmallForce-local Google Ads ad-account id from ads google accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads google campaigns`](/docs/cli/commands/ads/google/campaigns): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/campaigns/create-paused -->

# `smallforce ads google campaigns create-paused`

Create a paused Google Search or Performance Max campaign

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google campaigns create-paused --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads google campaigns create-paused [options]

Create a paused Google Search or Performance Max campaign

Options:
  --input <json>       Inline JSON request object
  --input-file <path>  JSON request file; use - to read from stdin
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  -h, --help           display help for command
```

## Related reference

- [`smallforce ads google campaigns`](/docs/cli/commands/ads/google/campaigns): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/bidding -->

# `smallforce ads google bidding`

Manage Google Ads bidding

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google bidding --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce ads google bidding list`](/docs/cli/commands/ads/google/bidding/list): List portfolio bid strategies
- [`smallforce ads google bidding create`](/docs/cli/commands/ads/google/bidding/create): Create a portfolio bid strategy
- [`smallforce ads google bidding update`](/docs/cli/commands/ads/google/bidding/update): Update a portfolio bid strategy

## Complete command help

```text
Usage: smallforce ads google bidding [options] [command]

Manage Google Ads bidding

Options:
  -h, --help                   display help for command

Commands:
  list [options]               List portfolio bid strategies
  create [options]             Create a portfolio bid strategy
  update [options] <targetId>  Update a portfolio bid strategy
  help [command]               display help for command
```

## Related reference

- [`smallforce ads google`](/docs/cli/commands/ads/google): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/bidding/list -->

# `smallforce ads google bidding list`

List portfolio bid strategies

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google bidding list --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads google bidding list [options]

List portfolio bid strategies

Options:
  --account <adAccountId>  SmallForce-local Google Ads ad-account id from ads google accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads google bidding`](/docs/cli/commands/ads/google/bidding): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/bidding/create -->

# `smallforce ads google bidding create`

Create a portfolio bid strategy

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google bidding create --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads google bidding create [options]

Create a portfolio bid strategy

Options:
  --account <adAccountId>  SmallForce-local Google Ads ad-account id from ads google accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads google bidding`](/docs/cli/commands/ads/google/bidding): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/bidding/update -->

# `smallforce ads google bidding update`

Update a portfolio bid strategy

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google bidding update --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads google bidding update [options] <targetId>

Update a portfolio bid strategy

Arguments:
  targetId                 SmallForce-local bid_strategy id; raw Google Ads ids are rejected

Options:
  --account <adAccountId>  SmallForce-local Google Ads ad-account id from ads google accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads google bidding`](/docs/cli/commands/ads/google/bidding): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/keywords -->

# `smallforce ads google keywords`

Inspect keywords, search terms, and Keyword Planner data

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google keywords --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce ads google keywords add`](/docs/cli/commands/ads/google/keywords/add): Add keywords without replacing existing criteria
- [`smallforce ads google keywords update`](/docs/cli/commands/ads/google/keywords/update): Pause or enable one keyword
- [`smallforce ads google keywords remove`](/docs/cli/commands/ads/google/keywords/remove): Remove one keyword
- [`smallforce ads google keywords list`](/docs/cli/commands/ads/google/keywords/list): List synchronized Google Ads keywords
- [`smallforce ads google keywords search-terms`](/docs/cli/commands/ads/google/keywords/search-terms): Read Google Ads search-term performance
- [`smallforce ads google keywords ideas`](/docs/cli/commands/ads/google/keywords/ideas): Generate Google Keyword Planner ideas
- [`smallforce ads google keywords historical-metrics`](/docs/cli/commands/ads/google/keywords/historical-metrics): Read historical Google keyword metrics

## Complete command help

```text
Usage: smallforce ads google keywords [options] [command]

Inspect keywords, search terms, and Keyword Planner data

Options:
  -h, --help                    display help for command

Commands:
  add [options] <targetId>      Add keywords without replacing existing criteria
  update [options] <targetId>   Pause or enable one keyword
  remove [options] <targetId>   Remove one keyword
  list [options]                List synchronized Google Ads keywords
  search-terms [options]        Read Google Ads search-term performance
  ideas [options]               Generate Google Keyword Planner ideas
  historical-metrics [options]  Read historical Google keyword metrics
  help [command]                display help for command
```

## Related reference

- [`smallforce ads google`](/docs/cli/commands/ads/google): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/keywords/add -->

# `smallforce ads google keywords add`

Add keywords without replacing existing criteria

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google keywords add --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads google keywords add [options] <targetId>

Add keywords without replacing existing criteria

Arguments:
  targetId                 SmallForce-local ad_set id; raw Google Ads ids are rejected

Options:
  --account <adAccountId>  SmallForce-local Google Ads ad-account id from ads google accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads google keywords`](/docs/cli/commands/ads/google/keywords): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/keywords/update -->

# `smallforce ads google keywords update`

Pause or enable one keyword

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google keywords update --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads google keywords update [options] <targetId>

Pause or enable one keyword

Arguments:
  targetId                 SmallForce-local keyword id; raw Google Ads ids are rejected

Options:
  --account <adAccountId>  SmallForce-local Google Ads ad-account id from ads google accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads google keywords`](/docs/cli/commands/ads/google/keywords): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/keywords/remove -->

# `smallforce ads google keywords remove`

Remove one keyword

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google keywords remove --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads google keywords remove [options] <targetId>

Remove one keyword

Arguments:
  targetId                 SmallForce-local keyword id; raw Google Ads ids are rejected

Options:
  --account <adAccountId>  SmallForce-local Google Ads ad-account id from ads google accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads google keywords`](/docs/cli/commands/ads/google/keywords): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/keywords/list -->

# `smallforce ads google keywords list`

List synchronized Google Ads keywords

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google keywords list --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads google keywords list [options]

List synchronized Google Ads keywords

Options:
  --account <adAccountId>  SmallForce-local Google Ads ad-account id from ads google accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads google keywords`](/docs/cli/commands/ads/google/keywords): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/keywords/search-terms -->

# `smallforce ads google keywords search-terms`

Read Google Ads search-term performance

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google keywords search-terms --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads google keywords search-terms [options]

Read Google Ads search-term performance

Options:
  --account <adAccountId>  SmallForce-local Google Ads ad-account id from ads google accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads google keywords`](/docs/cli/commands/ads/google/keywords): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/keywords/ideas -->

# `smallforce ads google keywords ideas`

Generate Google Keyword Planner ideas

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google keywords ideas --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads google keywords ideas [options]

Generate Google Keyword Planner ideas

Options:
  --account <adAccountId>  SmallForce-local Google Ads ad-account id from ads google accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads google keywords`](/docs/cli/commands/ads/google/keywords): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/keywords/historical-metrics -->

# `smallforce ads google keywords historical-metrics`

Read historical Google keyword metrics

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google keywords historical-metrics --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads google keywords historical-metrics [options]

Read historical Google keyword metrics

Options:
  --account <adAccountId>  SmallForce-local Google Ads ad-account id from ads google accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads google keywords`](/docs/cli/commands/ads/google/keywords): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/ad-groups -->

# `smallforce ads google ad-groups`

Manage Google Ads ad groups

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google ad-groups --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce ads google ad-groups list`](/docs/cli/commands/ads/google/ad-groups/list): List ad groups including empty groups
- [`smallforce ads google ad-groups create`](/docs/cli/commands/ads/google/ad-groups/create): Create a paused Search ad group
- [`smallforce ads google ad-groups delete`](/docs/cli/commands/ads/google/ad-groups/delete): Delete an ad group and its ads
- [`smallforce ads google ad-groups update`](/docs/cli/commands/ads/google/ad-groups/update): Update a Google Ads ad group
- [`smallforce ads google ad-groups status`](/docs/cli/commands/ads/google/ad-groups/status): Pause or resume a Google Ads ad group

## Complete command help

```text
Usage: smallforce ads google ad-groups [options] [command]

Manage Google Ads ad groups

Options:
  -h, --help                   display help for command

Commands:
  list [options]               List ad groups including empty groups
  create [options] <targetId>  Create a paused Search ad group
  delete [options] <targetId>  Delete an ad group and its ads
  update [options] <targetId>  Update a Google Ads ad group
  status [options] <targetId>  Pause or resume a Google Ads ad group
  help [command]               display help for command
```

## Related reference

- [`smallforce ads google`](/docs/cli/commands/ads/google): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/ad-groups/list -->

# `smallforce ads google ad-groups list`

List ad groups including empty groups

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google ad-groups list --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads google ad-groups list [options]

List ad groups including empty groups

Options:
  --account <adAccountId>  SmallForce-local Google Ads ad-account id from ads google accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads google ad-groups`](/docs/cli/commands/ads/google/ad-groups): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/ad-groups/create -->

# `smallforce ads google ad-groups create`

Create a paused Search ad group

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google ad-groups create --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads google ad-groups create [options] <targetId>

Create a paused Search ad group

Arguments:
  targetId                 SmallForce-local campaign id; raw Google Ads ids are rejected

Options:
  --account <adAccountId>  SmallForce-local Google Ads ad-account id from ads google accounts list
  --idempotency-key <key>  Stable mutation key; reuse after a timeout, never generate a new key for
                           an uncertain result
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads google ad-groups`](/docs/cli/commands/ads/google/ad-groups): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/ad-groups/delete -->

# `smallforce ads google ad-groups delete`

Delete an ad group and its ads

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google ad-groups delete --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads google ad-groups delete [options] <targetId>

Delete an ad group and its ads

Arguments:
  targetId                 SmallForce-local ad_set id; raw Google Ads ids are rejected

Options:
  --account <adAccountId>  SmallForce-local Google Ads ad-account id from ads google accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads google ad-groups`](/docs/cli/commands/ads/google/ad-groups): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/ad-groups/update -->

# `smallforce ads google ad-groups update`

Update a Google Ads ad group

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google ad-groups update --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads google ad-groups update [options] <targetId>

Update a Google Ads ad group

Arguments:
  targetId                 SmallForce-local ad_set id; raw Google Ads ids are rejected

Options:
  --account <adAccountId>  SmallForce-local Google Ads ad-account id from ads google accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads google ad-groups`](/docs/cli/commands/ads/google/ad-groups): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/ad-groups/status -->

# `smallforce ads google ad-groups status`

Pause or resume a Google Ads ad group

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google ad-groups status --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads google ad-groups status [options] <targetId>

Pause or resume a Google Ads ad group

Arguments:
  targetId                 SmallForce-local ad_set id; raw Google Ads ids are rejected

Options:
  --account <adAccountId>  SmallForce-local Google Ads ad-account id from ads google accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads google ad-groups`](/docs/cli/commands/ads/google/ad-groups): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/conversions -->

# `smallforce ads google conversions`

Manage conversion actions and send conversion events

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google conversions --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce ads google conversions actions`](/docs/cli/commands/ads/google/conversions/actions): List website conversion actions and tag snippets
- [`smallforce ads google conversions create-action`](/docs/cli/commands/ads/google/conversions/create-action): Create a website conversion action and tag snippets
- [`smallforce ads google conversions send`](/docs/cli/commands/ads/google/conversions/send): Send Google offline or enhanced conversions
- [`smallforce ads google conversions adjust`](/docs/cli/commands/ads/google/conversions/adjust): Retract, restate, or enhance Google conversions
- [`smallforce ads google conversions destinations`](/docs/cli/commands/ads/google/conversions/destinations): List Google conversion actions
- [`smallforce ads google conversions create-destination`](/docs/cli/commands/ads/google/conversions/create-destination): Create a Google conversion action

## Complete command help

```text
Usage: smallforce ads google conversions [options] [command]

Manage conversion actions and send conversion events

Options:
  -h, --help                    display help for command

Commands:
  actions [options]             List website conversion actions and tag snippets
  create-action [options]       Create a website conversion action and tag snippets
  send [options] <targetId>     Send Google offline or enhanced conversions
  adjust [options] <targetId>   Retract, restate, or enhance Google conversions
  destinations [options]        List Google conversion actions
  create-destination [options]  Create a Google conversion action
  help [command]                display help for command
```

## Related reference

- [`smallforce ads google`](/docs/cli/commands/ads/google): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/conversions/actions -->

# `smallforce ads google conversions actions`

List website conversion actions and tag snippets

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google conversions actions --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads google conversions actions [options]

List website conversion actions and tag snippets

Options:
  --account <adAccountId>  SmallForce-local Google Ads ad-account id from ads google accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads google conversions`](/docs/cli/commands/ads/google/conversions): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/conversions/create-action -->

# `smallforce ads google conversions create-action`

Create a website conversion action and tag snippets

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google conversions create-action --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads google conversions create-action [options]

Create a website conversion action and tag snippets

Options:
  --account <adAccountId>  SmallForce-local Google Ads ad-account id from ads google accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads google conversions`](/docs/cli/commands/ads/google/conversions): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/conversions/send -->

# `smallforce ads google conversions send`

Send Google offline or enhanced conversions

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google conversions send --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads google conversions send [options] <targetId>

Send Google offline or enhanced conversions

Arguments:
  targetId                 SmallForce-local conversion_destination id; raw Google Ads ids are
                           rejected

Options:
  --account <adAccountId>  SmallForce-local Google Ads ad-account id from ads google accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads google conversions`](/docs/cli/commands/ads/google/conversions): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/conversions/adjust -->

# `smallforce ads google conversions adjust`

Retract, restate, or enhance Google conversions

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google conversions adjust --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads google conversions adjust [options] <targetId>

Retract, restate, or enhance Google conversions

Arguments:
  targetId                 SmallForce-local conversion_destination id; raw Google Ads ids are
                           rejected

Options:
  --account <adAccountId>  SmallForce-local Google Ads ad-account id from ads google accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads google conversions`](/docs/cli/commands/ads/google/conversions): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/conversions/destinations -->

# `smallforce ads google conversions destinations`

List Google conversion actions

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google conversions destinations --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads google conversions destinations [options]

List Google conversion actions

Options:
  --account <adAccountId>  SmallForce-local Google Ads ad-account id from ads google accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads google conversions`](/docs/cli/commands/ads/google/conversions): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/conversions/create-destination -->

# `smallforce ads google conversions create-destination`

Create a Google conversion action

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google conversions create-destination --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads google conversions create-destination [options]

Create a Google conversion action

Options:
  --account <adAccountId>  SmallForce-local Google Ads ad-account id from ads google accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads google conversions`](/docs/cli/commands/ads/google/conversions): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/advertisements -->

# `smallforce ads google advertisements`

Create and manage Google advertisements

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google advertisements --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce ads google advertisements list`](/docs/cli/commands/ads/google/advertisements/list): List Google advertisements
- [`smallforce ads google advertisements get`](/docs/cli/commands/ads/google/advertisements/get): Read one Google advertisement
- [`smallforce ads google advertisements update`](/docs/cli/commands/ads/google/advertisements/update): Update Google ad status, budget, or Search keywords
- [`smallforce ads google advertisements delete`](/docs/cli/commands/ads/google/advertisements/delete): Delete a Google advertisement
- [`smallforce ads google advertisements status`](/docs/cli/commands/ads/google/advertisements/status): Pause or resume a Google advertisement
- [`smallforce ads google advertisements create`](/docs/cli/commands/ads/google/advertisements/create): Create a paused Google Search, Display, Performance Max or Demand Gen campaign hierarchy
- [`smallforce ads google advertisements analytics`](/docs/cli/commands/ads/google/advertisements/analytics): Read analytics for one Google advertisement

## Complete command help

```text
Usage: smallforce ads google advertisements [options] [command]

Create and manage Google advertisements

Options:
  -h, --help                      display help for command

Commands:
  list [options]                  List Google advertisements
  get [options] <targetId>        Read one Google advertisement
  update [options] <targetId>     Update Google ad status, budget, or Search keywords
  delete [options] <targetId>     Delete a Google advertisement
  status [options] <targetId>     Pause or resume a Google advertisement
  create [options]                Create a paused Google Search, Display, Performance Max or Demand
                                  Gen campaign hierarchy
  analytics [options] <targetId>  Read analytics for one Google advertisement
  help [command]                  display help for command
```

## Related reference

- [`smallforce ads google`](/docs/cli/commands/ads/google): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/advertisements/list -->

# `smallforce ads google advertisements list`

List Google advertisements

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google advertisements list --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads google advertisements list [options]

List Google advertisements

Options:
  --account <adAccountId>  SmallForce-local Google Ads ad-account id from ads google accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads google advertisements`](/docs/cli/commands/ads/google/advertisements): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/advertisements/get -->

# `smallforce ads google advertisements get`

Read one Google advertisement

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google advertisements get --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads google advertisements get [options] <targetId>

Read one Google advertisement

Arguments:
  targetId                 SmallForce-local ad id; raw Google Ads ids are rejected

Options:
  --account <adAccountId>  SmallForce-local Google Ads ad-account id from ads google accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads google advertisements`](/docs/cli/commands/ads/google/advertisements): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/advertisements/update -->

# `smallforce ads google advertisements update`

Update Google ad status, budget, or Search keywords

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google advertisements update --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads google advertisements update [options] <targetId>

Update Google ad status, budget, or Search keywords

Arguments:
  targetId                 SmallForce-local ad id; raw Google Ads ids are rejected

Options:
  --account <adAccountId>  SmallForce-local Google Ads ad-account id from ads google accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads google advertisements`](/docs/cli/commands/ads/google/advertisements): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/advertisements/delete -->

# `smallforce ads google advertisements delete`

Delete a Google advertisement

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google advertisements delete --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads google advertisements delete [options] <targetId>

Delete a Google advertisement

Arguments:
  targetId                 SmallForce-local ad id; raw Google Ads ids are rejected

Options:
  --account <adAccountId>  SmallForce-local Google Ads ad-account id from ads google accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads google advertisements`](/docs/cli/commands/ads/google/advertisements): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/advertisements/status -->

# `smallforce ads google advertisements status`

Pause or resume a Google advertisement

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google advertisements status --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads google advertisements status [options] <targetId>

Pause or resume a Google advertisement

Arguments:
  targetId                 SmallForce-local ad id; raw Google Ads ids are rejected

Options:
  --account <adAccountId>  SmallForce-local Google Ads ad-account id from ads google accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads google advertisements`](/docs/cli/commands/ads/google/advertisements): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/advertisements/create -->

# `smallforce ads google advertisements create`

Create a paused Google Search, Display, Performance Max or Demand Gen campaign hierarchy

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google advertisements create --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads google advertisements create [options]

Create a paused Google Search, Display, Performance Max or Demand Gen campaign hierarchy

Options:
  --account <adAccountId>  SmallForce-local Google Ads ad-account id from ads google accounts list
  --idempotency-key <key>  Stable mutation key; reuse after a timeout, never generate a new key for
                           an uncertain result
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads google advertisements`](/docs/cli/commands/ads/google/advertisements): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/advertisements/analytics -->

# `smallforce ads google advertisements analytics`

Read analytics for one Google advertisement

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google advertisements analytics --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads google advertisements analytics [options] <targetId>

Read analytics for one Google advertisement

Arguments:
  targetId                 SmallForce-local ad id; raw Google Ads ids are rejected

Options:
  --account <adAccountId>  SmallForce-local Google Ads ad-account id from ads google accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads google advertisements`](/docs/cli/commands/ads/google/advertisements): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/insights -->

# `smallforce ads google insights`

Read timelines and run Google Ads Query Language queries

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google insights --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce ads google insights timeline`](/docs/cli/commands/ads/google/insights/timeline): Read Google Ads daily performance
- [`smallforce ads google insights query`](/docs/cli/commands/ads/google/insights/query): Run a Google Ads GAQL query

## Complete command help

```text
Usage: smallforce ads google insights [options] [command]

Read timelines and run Google Ads Query Language queries

Options:
  -h, --help          display help for command

Commands:
  timeline [options]  Read Google Ads daily performance
  query [options]     Run a Google Ads GAQL query
  help [command]      display help for command
```

## Related reference

- [`smallforce ads google`](/docs/cli/commands/ads/google): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/insights/timeline -->

# `smallforce ads google insights timeline`

Read Google Ads daily performance

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google insights timeline --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads google insights timeline [options]

Read Google Ads daily performance

Options:
  --account <adAccountId>  SmallForce-local Google Ads ad-account id from ads google accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads google insights`](/docs/cli/commands/ads/google/insights): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/insights/query -->

# `smallforce ads google insights query`

Run a Google Ads GAQL query

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google insights query --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads google insights query [options]

Run a Google Ads GAQL query

Options:
  --account <adAccountId>  SmallForce-local Google Ads ad-account id from ads google accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads google insights`](/docs/cli/commands/ads/google/insights): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/local-services -->

# `smallforce ads google local-services`

Read Google Local Services Ads leads and conversations

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google local-services --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce ads google local-services leads`](/docs/cli/commands/ads/google/local-services/leads): List Google Local Services Ads leads
- [`smallforce ads google local-services conversations`](/docs/cli/commands/ads/google/local-services/conversations): Read conversations for a Local Services lead

## Complete command help

```text
Usage: smallforce ads google local-services [options] [command]

Read Google Local Services Ads leads and conversations

Options:
  -h, --help                          display help for command

Commands:
  leads [options]                     List Google Local Services Ads leads
  conversations [options] <targetId>  Read conversations for a Local Services lead
  help [command]                      display help for command
```

## Related reference

- [`smallforce ads google`](/docs/cli/commands/ads/google): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/local-services/leads -->

# `smallforce ads google local-services leads`

List Google Local Services Ads leads

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google local-services leads --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads google local-services leads [options]

List Google Local Services Ads leads

Options:
  --account <adAccountId>  SmallForce-local Google Ads ad-account id from ads google accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads google local-services`](/docs/cli/commands/ads/google/local-services): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/local-services/conversations -->

# `smallforce ads google local-services conversations`

Read conversations for a Local Services lead

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google local-services conversations --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads google local-services conversations [options] <targetId>

Read conversations for a Local Services lead

Arguments:
  targetId                 SmallForce-local local_services_lead id; raw Google Ads ids are rejected

Options:
  --account <adAccountId>  SmallForce-local Google Ads ad-account id from ads google accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads google local-services`](/docs/cli/commands/ads/google/local-services): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/tracking -->

# `smallforce ads google tracking`

Read and update Google campaign URL tracking settings

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google tracking --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce ads google tracking get`](/docs/cli/commands/ads/google/tracking/get): Read Google campaign URL tracking settings
- [`smallforce ads google tracking update`](/docs/cli/commands/ads/google/tracking/update): Update Google campaign URL tracking settings

## Complete command help

```text
Usage: smallforce ads google tracking [options] [command]

Read and update Google campaign URL tracking settings

Options:
  -h, --help                   display help for command

Commands:
  get [options] <targetId>     Read Google campaign URL tracking settings
  update [options] <targetId>  Update Google campaign URL tracking settings
  help [command]               display help for command
```

## Related reference

- [`smallforce ads google`](/docs/cli/commands/ads/google): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/tracking/get -->

# `smallforce ads google tracking get`

Read Google campaign URL tracking settings

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google tracking get --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads google tracking get [options] <targetId>

Read Google campaign URL tracking settings

Arguments:
  targetId                 SmallForce-local ad id; raw Google Ads ids are rejected

Options:
  --account <adAccountId>  SmallForce-local Google Ads ad-account id from ads google accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads google tracking`](/docs/cli/commands/ads/google/tracking): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/tracking/update -->

# `smallforce ads google tracking update`

Update Google campaign URL tracking settings

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google tracking update --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads google tracking update [options] <targetId>

Update Google campaign URL tracking settings

Arguments:
  targetId                 SmallForce-local ad id; raw Google Ads ids are rejected

Options:
  --account <adAccountId>  SmallForce-local Google Ads ad-account id from ads google accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads google tracking`](/docs/cli/commands/ads/google/tracking): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/targeting -->

# `smallforce ads google targeting`

Search Google Ads targeting options

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google targeting --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce ads google targeting search`](/docs/cli/commands/ads/google/targeting/search): Search Google Ads targeting options

## Complete command help

```text
Usage: smallforce ads google targeting [options] [command]

Search Google Ads targeting options

Options:
  -h, --help        display help for command

Commands:
  search [options]  Search Google Ads targeting options
  help [command]    display help for command
```

## Related reference

- [`smallforce ads google`](/docs/cli/commands/ads/google): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/targeting/search -->

# `smallforce ads google targeting search`

Search Google Ads targeting options

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google targeting search --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads google targeting search [options]

Search Google Ads targeting options

Options:
  --account <adAccountId>  SmallForce-local Google Ads ad-account id from ads google accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads google targeting`](/docs/cli/commands/ads/google/targeting): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/audiences -->

# `smallforce ads google audiences`

Manage Google customer-list, website and lookalike audiences

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google audiences --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce ads google audiences list`](/docs/cli/commands/ads/google/audiences/list): List Google Customer Match audiences
- [`smallforce ads google audiences create`](/docs/cli/commands/ads/google/audiences/create): Create a Google Customer Match audience
- [`smallforce ads google audiences get`](/docs/cli/commands/ads/google/audiences/get): Read a Google Customer Match audience
- [`smallforce ads google audiences delete`](/docs/cli/commands/ads/google/audiences/delete): Delete a Google Customer Match audience
- [`smallforce ads google audiences add-users`](/docs/cli/commands/ads/google/audiences/add-users): Upload members to a Google Customer Match audience

## Complete command help

```text
Usage: smallforce ads google audiences [options] [command]

Manage Google customer-list, website and lookalike audiences

Options:
  -h, --help                      display help for command

Commands:
  list [options]                  List Google Customer Match audiences
  create [options]                Create a Google Customer Match audience
  get [options] <targetId>        Read a Google Customer Match audience
  delete [options] <targetId>     Delete a Google Customer Match audience
  add-users [options] <targetId>  Upload members to a Google Customer Match audience
  help [command]                  display help for command
```

## Related reference

- [`smallforce ads google`](/docs/cli/commands/ads/google): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/audiences/list -->

# `smallforce ads google audiences list`

List Google Customer Match audiences

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google audiences list --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads google audiences list [options]

List Google Customer Match audiences

Options:
  --account <adAccountId>  SmallForce-local Google Ads ad-account id from ads google accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads google audiences`](/docs/cli/commands/ads/google/audiences): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/audiences/create -->

# `smallforce ads google audiences create`

Create a Google Customer Match audience

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google audiences create --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads google audiences create [options]

Create a Google Customer Match audience

Options:
  --account <adAccountId>  SmallForce-local Google Ads ad-account id from ads google accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads google audiences`](/docs/cli/commands/ads/google/audiences): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/audiences/get -->

# `smallforce ads google audiences get`

Read a Google Customer Match audience

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google audiences get --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads google audiences get [options] <targetId>

Read a Google Customer Match audience

Arguments:
  targetId                 SmallForce-local audience id; raw Google Ads ids are rejected

Options:
  --account <adAccountId>  SmallForce-local Google Ads ad-account id from ads google accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads google audiences`](/docs/cli/commands/ads/google/audiences): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/audiences/delete -->

# `smallforce ads google audiences delete`

Delete a Google Customer Match audience

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google audiences delete --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads google audiences delete [options] <targetId>

Delete a Google Customer Match audience

Arguments:
  targetId                 SmallForce-local audience id; raw Google Ads ids are rejected

Options:
  --account <adAccountId>  SmallForce-local Google Ads ad-account id from ads google accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads google audiences`](/docs/cli/commands/ads/google/audiences): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/google/audiences/add-users -->

# `smallforce ads google audiences add-users`

Upload members to a Google Customer Match audience

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads google audiences add-users --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads google audiences add-users [options] <targetId>

Upload members to a Google Customer Match audience

Arguments:
  targetId                 SmallForce-local audience id; raw Google Ads ids are rejected

Options:
  --account <adAccountId>  SmallForce-local Google Ads ad-account id from ads google accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads google audiences`](/docs/cli/commands/ads/google/audiences): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/tiktok -->

# `smallforce ads tiktok`

Manage TikTok Ads through SmallForce-local, organization-scoped IDs

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads tiktok --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce ads tiktok connections`](/docs/cli/commands/ads/tiktok/connections): Connect and activate TikTok Ads credentials
- [`smallforce ads tiktok accounts`](/docs/cli/commands/ads/tiktok/accounts): Synchronize and inspect TikTok Ads accounts
- [`smallforce ads tiktok business-centers`](/docs/cli/commands/ads/tiktok/business-centers): Inspect TikTok Business Centers visible to a connection
- [`smallforce ads tiktok ad-sets`](/docs/cli/commands/ads/tiktok/ad-sets): Manage TikTok Ads ad-sets
- [`smallforce ads tiktok review`](/docs/cli/commands/ads/tiktok/review): Manage TikTok Ads review
- [`smallforce ads tiktok identities`](/docs/cli/commands/ads/tiktok/identities): Manage TikTok Ads identities
- [`smallforce ads tiktok materials`](/docs/cli/commands/ads/tiktok/materials): Manage TikTok Ads materials
- [`smallforce ads tiktok comments`](/docs/cli/commands/ads/tiktok/comments): Manage TikTok Ads comments
- [`smallforce ads tiktok pixels`](/docs/cli/commands/ads/tiktok/pixels): Manage TikTok Ads pixels
- [`smallforce ads tiktok ad-groups`](/docs/cli/commands/ads/tiktok/ad-groups): Manage TikTok Ads ad groups
- [`smallforce ads tiktok advertisements`](/docs/cli/commands/ads/tiktok/advertisements): Create and manage TikTok advertisements and Spark Ads
- [`smallforce ads tiktok campaigns`](/docs/cli/commands/ads/tiktok/campaigns): Inspect and manage TikTok Ads campaigns
- [`smallforce ads tiktok insights`](/docs/cli/commands/ads/tiktok/insights): Read TikTok Ads performance timelines
- [`smallforce ads tiktok targeting`](/docs/cli/commands/ads/tiktok/targeting): Search TikTok Ads targeting options
- [`smallforce ads tiktok audiences`](/docs/cli/commands/ads/tiktok/audiences): Manage TikTok customer-list audiences
- [`smallforce ads tiktok conversions`](/docs/cli/commands/ads/tiktok/conversions): Discover destinations and send TikTok conversion events

## Complete command help

```text
Usage: smallforce ads tiktok [options] [command]

Manage TikTok Ads through SmallForce-local, organization-scoped IDs

Options:
  -h, --help        display help for command

Commands:
  connections       Connect and activate TikTok Ads credentials
  accounts          Synchronize and inspect TikTok Ads accounts
  business-centers  Inspect TikTok Business Centers visible to a connection
  ad-sets           Manage TikTok Ads ad-sets
  review            Manage TikTok Ads review
  identities        Manage TikTok Ads identities
  materials         Manage TikTok Ads materials
  comments          Manage TikTok Ads comments
  pixels            Manage TikTok Ads pixels
  ad-groups         Manage TikTok Ads ad groups
  advertisements    Create and manage TikTok advertisements and Spark Ads
  campaigns         Inspect and manage TikTok Ads campaigns
  insights          Read TikTok Ads performance timelines
  targeting         Search TikTok Ads targeting options
  audiences         Manage TikTok customer-list audiences
  conversions       Discover destinations and send TikTok conversion events
  help [command]    display help for command
```

## Related reference

- [`smallforce ads`](/docs/cli/commands/ads): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/tiktok/connections -->

# `smallforce ads tiktok connections`

Connect and activate TikTok Ads credentials

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads tiktok connections --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce ads tiktok connections connect`](/docs/cli/commands/ads/tiktok/connections/connect): Create or reuse a managed TikTok Ads OAuth connection
- [`smallforce ads tiktok connections list`](/docs/cli/commands/ads/tiktok/connections/list): List TikTok Ads connections and activation state
- [`smallforce ads tiktok connections activate`](/docs/cli/commands/ads/tiktok/connections/activate): Activate billing for one TikTok Ads connection
- [`smallforce ads tiktok connections disconnect`](/docs/cli/commands/ads/tiktok/connections/disconnect): Disconnect one TikTok Ads credential
- [`smallforce ads tiktok connections brand-identity`](/docs/cli/commands/ads/tiktok/connections/brand-identity): Configure the TikTok Ads custom identity for a connection

## Complete command help

```text
Usage: smallforce ads tiktok connections [options] [command]

Connect and activate TikTok Ads credentials

Options:
  -h, --help                                  display help for command

Commands:
  connect [options]                           Create or reuse a managed TikTok Ads OAuth connection
  list [options]                              List TikTok Ads connections and activation state
  activate [options] <socialAccountId>        Activate billing for one TikTok Ads connection
  disconnect [options] <socialAccountId>      Disconnect one TikTok Ads credential
  brand-identity [options] <socialAccountId>  Configure the TikTok Ads custom identity for a
                                              connection
  help [command]                              display help for command
```

## Related reference

- [`smallforce ads tiktok`](/docs/cli/commands/ads/tiktok): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/tiktok/connections/connect -->

# `smallforce ads tiktok connections connect`

Create or reuse a managed TikTok Ads OAuth connection

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads tiktok connections connect --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads tiktok connections connect [options]

Create or reuse a managed TikTok Ads OAuth connection

Options:
  --profile <profileId>                Social profile id from social profiles list
  --posting-account <socialAccountId>  Local TikTok posting-account id to authorize Spark Ads
  --force                              Force a fresh TikTok authorization flow
  --api-key <key>                      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>                  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                               Print stable machine-readable JSON
  --text                               Print human-readable text
  --format <format>                    Output format: text or json
  -h, --help                           display help for command
```

## Related reference

- [`smallforce ads tiktok connections`](/docs/cli/commands/ads/tiktok/connections): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/tiktok/connections/list -->

# `smallforce ads tiktok connections list`

List TikTok Ads connections and activation state

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads tiktok connections list --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads tiktok connections list [options]

List TikTok Ads connections and activation state

Options:
  --profile <profileId>  Filter by one social profile
  --include-deleted      Include disconnected connections
  --api-key <key>        SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>    SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                 Print stable machine-readable JSON
  --text                 Print human-readable text
  --format <format>      Output format: text or json
  -h, --help             display help for command
```

## Related reference

- [`smallforce ads tiktok connections`](/docs/cli/commands/ads/tiktok/connections): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/tiktok/connections/activate -->

# `smallforce ads tiktok connections activate`

Activate billing for one TikTok Ads connection

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads tiktok connections activate --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads tiktok connections activate [options] <socialAccountId>

Activate billing for one TikTok Ads connection

Arguments:
  socialAccountId      Local connection id

Options:
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  -h, --help           display help for command
```

## Related reference

- [`smallforce ads tiktok connections`](/docs/cli/commands/ads/tiktok/connections): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/tiktok/connections/disconnect -->

# `smallforce ads tiktok connections disconnect`

Disconnect one TikTok Ads credential

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads tiktok connections disconnect --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads tiktok connections disconnect [options] <socialAccountId>

Disconnect one TikTok Ads credential

Arguments:
  socialAccountId      Local connection id

Options:
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  -h, --help           display help for command
```

## Related reference

- [`smallforce ads tiktok connections`](/docs/cli/commands/ads/tiktok/connections): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/tiktok/connections/brand-identity -->

# `smallforce ads tiktok connections brand-identity`

Configure the TikTok Ads custom identity for a connection

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads tiktok connections brand-identity --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads tiktok connections brand-identity [options] <socialAccountId>

Configure the TikTok Ads custom identity for a connection

Arguments:
  socialAccountId        SmallForce-local TikTok Ads connection id

Options:
  --display-name <name>  TikTok Ads display name
  --asset <assetId>      SmallForce image asset id for the identity avatar
  --api-key <key>        SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>    SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                 Print stable machine-readable JSON
  --text                 Print human-readable text
  --format <format>      Output format: text or json
  -h, --help             display help for command
```

## Related reference

- [`smallforce ads tiktok connections`](/docs/cli/commands/ads/tiktok/connections): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/tiktok/accounts -->

# `smallforce ads tiktok accounts`

Synchronize and inspect TikTok Ads accounts

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads tiktok accounts --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce ads tiktok accounts list`](/docs/cli/commands/ads/tiktok/accounts/list): List local TikTok Ads account IDs
- [`smallforce ads tiktok accounts sync`](/docs/cli/commands/ads/tiktok/accounts/sync): Synchronize provider accounts for one TikTok Ads connection
- [`smallforce ads tiktok accounts live`](/docs/cli/commands/ads/tiktok/accounts/live): Get ad account live entities

## Complete command help

```text
Usage: smallforce ads tiktok accounts [options] [command]

Synchronize and inspect TikTok Ads accounts

Options:
  -h, --help                        display help for command

Commands:
  list [options]                    List local TikTok Ads account IDs
  sync [options] <socialAccountId>  Synchronize provider accounts for one TikTok Ads connection
  live [options]                    Get ad account live entities
  help [command]                    display help for command
```

## Related reference

- [`smallforce ads tiktok`](/docs/cli/commands/ads/tiktok): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/tiktok/accounts/list -->

# `smallforce ads tiktok accounts list`

List local TikTok Ads account IDs

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads tiktok accounts list --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads tiktok accounts list [options]

List local TikTok Ads account IDs

Options:
  --connection <socialAccountId>  Filter by one TikTok Ads connection
  --api-key <key>                 SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>             SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                          Print stable machine-readable JSON
  --text                          Print human-readable text
  --format <format>               Output format: text or json
  -h, --help                      display help for command
```

## Related reference

- [`smallforce ads tiktok accounts`](/docs/cli/commands/ads/tiktok/accounts): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/tiktok/accounts/sync -->

# `smallforce ads tiktok accounts sync`

Synchronize provider accounts for one TikTok Ads connection

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads tiktok accounts sync --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads tiktok accounts sync [options] <socialAccountId>

Synchronize provider accounts for one TikTok Ads connection

Arguments:
  socialAccountId      Local connection id

Options:
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  -h, --help           display help for command
```

## Related reference

- [`smallforce ads tiktok accounts`](/docs/cli/commands/ads/tiktok/accounts): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/tiktok/accounts/live -->

# `smallforce ads tiktok accounts live`

Get ad account live entities

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads tiktok accounts live --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads tiktok accounts live [options]

Get ad account live entities

Options:
  --account <adAccountId>  SmallForce-local TikTok Ads ad-account id from ads tiktok accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads tiktok accounts`](/docs/cli/commands/ads/tiktok/accounts): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/tiktok/business-centers -->

# `smallforce ads tiktok business-centers`

Inspect TikTok Business Centers visible to a connection

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads tiktok business-centers --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce ads tiktok business-centers list`](/docs/cli/commands/ads/tiktok/business-centers/list): List TikTok Business Centers using a local connection

## Complete command help

```text
Usage: smallforce ads tiktok business-centers [options] [command]

Inspect TikTok Business Centers visible to a connection

Options:
  -h, --help      display help for command

Commands:
  list [options]  List TikTok Business Centers using a local connection
  help [command]  display help for command
```

## Related reference

- [`smallforce ads tiktok`](/docs/cli/commands/ads/tiktok): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/tiktok/business-centers/list -->

# `smallforce ads tiktok business-centers list`

List TikTok Business Centers using a local connection

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads tiktok business-centers list --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads tiktok business-centers list [options]

List TikTok Business Centers using a local connection

Options:
  --connection <socialAccountId>  SmallForce-local TikTok Ads connection id
  --api-key <key>                 SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>             SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                          Print stable machine-readable JSON
  --text                          Print human-readable text
  --format <format>               Output format: text or json
  -h, --help                      display help for command
```

## Related reference

- [`smallforce ads tiktok business-centers`](/docs/cli/commands/ads/tiktok/business-centers): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/tiktok/ad-sets -->

# `smallforce ads tiktok ad-sets`

Manage TikTok Ads ad-sets

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads tiktok ad-sets --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce ads tiktok ad-sets duplicate`](/docs/cli/commands/ads/tiktok/ad-sets/duplicate): Duplicate ad set

## Complete command help

```text
Usage: smallforce ads tiktok ad-sets [options] [command]

Manage TikTok Ads ad-sets

Options:
  -h, --help                      display help for command

Commands:
  duplicate [options] <targetId>  Duplicate ad set
  help [command]                  display help for command
```

## Related reference

- [`smallforce ads tiktok`](/docs/cli/commands/ads/tiktok): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/tiktok/ad-sets/duplicate -->

# `smallforce ads tiktok ad-sets duplicate`

Duplicate ad set

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads tiktok ad-sets duplicate --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads tiktok ad-sets duplicate [options] <targetId>

Duplicate ad set

Arguments:
  targetId                 SmallForce-local ad_set id; raw TikTok Ads ids are rejected

Options:
  --account <adAccountId>  SmallForce-local TikTok Ads ad-account id from ads tiktok accounts list
  --idempotency-key <key>  Stable mutation key; reuse after a timeout, never generate a new key for
                           an uncertain result
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads tiktok ad-sets`](/docs/cli/commands/ads/tiktok/ad-sets): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/tiktok/review -->

# `smallforce ads tiktok review`

Manage TikTok Ads review

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads tiktok review --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce ads tiktok review get`](/docs/cli/commands/ads/tiktok/review/get): Get ad review

## Complete command help

```text
Usage: smallforce ads tiktok review [options] [command]

Manage TikTok Ads review

Options:
  -h, --help                display help for command

Commands:
  get [options] <targetId>  Get ad review
  help [command]            display help for command
```

## Related reference

- [`smallforce ads tiktok`](/docs/cli/commands/ads/tiktok): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/tiktok/review/get -->

# `smallforce ads tiktok review get`

Get ad review

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads tiktok review get --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads tiktok review get [options] <targetId>

Get ad review

Arguments:
  targetId                 SmallForce-local ad id; raw TikTok Ads ids are rejected

Options:
  --account <adAccountId>  SmallForce-local TikTok Ads ad-account id from ads tiktok accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads tiktok review`](/docs/cli/commands/ads/tiktok/review): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/tiktok/identities -->

# `smallforce ads tiktok identities`

Manage TikTok Ads identities

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads tiktok identities --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce ads tiktok identities list`](/docs/cli/commands/ads/tiktok/identities/list): List TikTok ad identities

## Complete command help

```text
Usage: smallforce ads tiktok identities [options] [command]

Manage TikTok Ads identities

Options:
  -h, --help      display help for command

Commands:
  list [options]  List TikTok ad identities
  help [command]  display help for command
```

## Related reference

- [`smallforce ads tiktok`](/docs/cli/commands/ads/tiktok): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/tiktok/identities/list -->

# `smallforce ads tiktok identities list`

List TikTok ad identities

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads tiktok identities list --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads tiktok identities list [options]

List TikTok ad identities

Options:
  --account <adAccountId>  SmallForce-local TikTok Ads ad-account id from ads tiktok accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads tiktok identities`](/docs/cli/commands/ads/tiktok/identities): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/tiktok/materials -->

# `smallforce ads tiktok materials`

Manage TikTok Ads materials

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads tiktok materials --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce ads tiktok materials report`](/docs/cli/commands/ads/tiktok/materials/report): Per-creative performance inside TikTok Smart+ ads

## Complete command help

```text
Usage: smallforce ads tiktok materials [options] [command]

Manage TikTok Ads materials

Options:
  -h, --help        display help for command

Commands:
  report [options]  Per-creative performance inside TikTok Smart+ ads
  help [command]    display help for command
```

## Related reference

- [`smallforce ads tiktok`](/docs/cli/commands/ads/tiktok): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/tiktok/materials/report -->

# `smallforce ads tiktok materials report`

Per-creative performance inside TikTok Smart+ ads

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads tiktok materials report --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads tiktok materials report [options]

Per-creative performance inside TikTok Smart+ ads

Options:
  --account <adAccountId>  SmallForce-local TikTok Ads ad-account id from ads tiktok accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads tiktok materials`](/docs/cli/commands/ads/tiktok/materials): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/tiktok/comments -->

# `smallforce ads tiktok comments`

Manage TikTok Ads comments

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads tiktok comments --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce ads tiktok comments list`](/docs/cli/commands/ads/tiktok/comments/list): List comments on an ad
- [`smallforce ads tiktok comments reply`](/docs/cli/commands/ads/tiktok/comments/reply): Reply to an ad comment
- [`smallforce ads tiktok comments hide`](/docs/cli/commands/ads/tiktok/comments/hide): Hide or unhide an ad comment
- [`smallforce ads tiktok comments delete`](/docs/cli/commands/ads/tiktok/comments/delete): Delete an ad comment

## Complete command help

```text
Usage: smallforce ads tiktok comments [options] [command]

Manage TikTok Ads comments

Options:
  -h, --help                   display help for command

Commands:
  list [options] <targetId>    List comments on an ad
  reply [options] <targetId>   Reply to an ad comment
  hide [options] <targetId>    Hide or unhide an ad comment
  delete [options] <targetId>  Delete an ad comment
  help [command]               display help for command
```

## Related reference

- [`smallforce ads tiktok`](/docs/cli/commands/ads/tiktok): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/tiktok/comments/list -->

# `smallforce ads tiktok comments list`

List comments on an ad

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads tiktok comments list --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads tiktok comments list [options] <targetId>

List comments on an ad

Arguments:
  targetId                 SmallForce-local ad id; raw TikTok Ads ids are rejected

Options:
  --account <adAccountId>  SmallForce-local TikTok Ads ad-account id from ads tiktok accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads tiktok comments`](/docs/cli/commands/ads/tiktok/comments): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/tiktok/comments/reply -->

# `smallforce ads tiktok comments reply`

Reply to an ad comment

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads tiktok comments reply --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads tiktok comments reply [options] <targetId>

Reply to an ad comment

Arguments:
  targetId                 SmallForce-local ad id; raw TikTok Ads ids are rejected

Options:
  --account <adAccountId>  SmallForce-local TikTok Ads ad-account id from ads tiktok accounts list
  --idempotency-key <key>  Stable mutation key; reuse after a timeout, never generate a new key for
                           an uncertain result
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads tiktok comments`](/docs/cli/commands/ads/tiktok/comments): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/tiktok/comments/hide -->

# `smallforce ads tiktok comments hide`

Hide or unhide an ad comment

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads tiktok comments hide --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads tiktok comments hide [options] <targetId>

Hide or unhide an ad comment

Arguments:
  targetId                 SmallForce-local ad id; raw TikTok Ads ids are rejected

Options:
  --account <adAccountId>  SmallForce-local TikTok Ads ad-account id from ads tiktok accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads tiktok comments`](/docs/cli/commands/ads/tiktok/comments): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/tiktok/comments/delete -->

# `smallforce ads tiktok comments delete`

Delete an ad comment

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads tiktok comments delete --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads tiktok comments delete [options] <targetId>

Delete an ad comment

Arguments:
  targetId                 SmallForce-local ad id; raw TikTok Ads ids are rejected

Options:
  --account <adAccountId>  SmallForce-local TikTok Ads ad-account id from ads tiktok accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads tiktok comments`](/docs/cli/commands/ads/tiktok/comments): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/tiktok/pixels -->

# `smallforce ads tiktok pixels`

Manage TikTok Ads pixels

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads tiktok pixels --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce ads tiktok pixels list`](/docs/cli/commands/ads/tiktok/pixels/list): List TikTok ad pixels

## Complete command help

```text
Usage: smallforce ads tiktok pixels [options] [command]

Manage TikTok Ads pixels

Options:
  -h, --help      display help for command

Commands:
  list [options]  List TikTok ad pixels
  help [command]  display help for command
```

## Related reference

- [`smallforce ads tiktok`](/docs/cli/commands/ads/tiktok): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/tiktok/pixels/list -->

# `smallforce ads tiktok pixels list`

List TikTok ad pixels

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads tiktok pixels list --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads tiktok pixels list [options]

List TikTok ad pixels

Options:
  --account <adAccountId>  SmallForce-local TikTok Ads ad-account id from ads tiktok accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads tiktok pixels`](/docs/cli/commands/ads/tiktok/pixels): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/tiktok/ad-groups -->

# `smallforce ads tiktok ad-groups`

Manage TikTok Ads ad groups

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads tiktok ad-groups --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce ads tiktok ad-groups list`](/docs/cli/commands/ads/tiktok/ad-groups/list): List ad groups including empty groups
- [`smallforce ads tiktok ad-groups delete`](/docs/cli/commands/ads/tiktok/ad-groups/delete): Delete an ad group and its ads
- [`smallforce ads tiktok ad-groups update`](/docs/cli/commands/ads/tiktok/ad-groups/update): Update a TikTok Ads ad group
- [`smallforce ads tiktok ad-groups status`](/docs/cli/commands/ads/tiktok/ad-groups/status): Pause or resume a TikTok Ads ad group

## Complete command help

```text
Usage: smallforce ads tiktok ad-groups [options] [command]

Manage TikTok Ads ad groups

Options:
  -h, --help                   display help for command

Commands:
  list [options]               List ad groups including empty groups
  delete [options] <targetId>  Delete an ad group and its ads
  update [options] <targetId>  Update a TikTok Ads ad group
  status [options] <targetId>  Pause or resume a TikTok Ads ad group
  help [command]               display help for command
```

## Related reference

- [`smallforce ads tiktok`](/docs/cli/commands/ads/tiktok): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/tiktok/ad-groups/list -->

# `smallforce ads tiktok ad-groups list`

List ad groups including empty groups

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads tiktok ad-groups list --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads tiktok ad-groups list [options]

List ad groups including empty groups

Options:
  --account <adAccountId>  SmallForce-local TikTok Ads ad-account id from ads tiktok accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads tiktok ad-groups`](/docs/cli/commands/ads/tiktok/ad-groups): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/tiktok/ad-groups/delete -->

# `smallforce ads tiktok ad-groups delete`

Delete an ad group and its ads

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads tiktok ad-groups delete --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads tiktok ad-groups delete [options] <targetId>

Delete an ad group and its ads

Arguments:
  targetId                 SmallForce-local ad_set id; raw TikTok Ads ids are rejected

Options:
  --account <adAccountId>  SmallForce-local TikTok Ads ad-account id from ads tiktok accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads tiktok ad-groups`](/docs/cli/commands/ads/tiktok/ad-groups): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/tiktok/ad-groups/update -->

# `smallforce ads tiktok ad-groups update`

Update a TikTok Ads ad group

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads tiktok ad-groups update --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads tiktok ad-groups update [options] <targetId>

Update a TikTok Ads ad group

Arguments:
  targetId                 SmallForce-local ad_set id; raw TikTok Ads ids are rejected

Options:
  --account <adAccountId>  SmallForce-local TikTok Ads ad-account id from ads tiktok accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads tiktok ad-groups`](/docs/cli/commands/ads/tiktok/ad-groups): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/tiktok/ad-groups/status -->

# `smallforce ads tiktok ad-groups status`

Pause or resume a TikTok Ads ad group

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads tiktok ad-groups status --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads tiktok ad-groups status [options] <targetId>

Pause or resume a TikTok Ads ad group

Arguments:
  targetId                 SmallForce-local ad_set id; raw TikTok Ads ids are rejected

Options:
  --account <adAccountId>  SmallForce-local TikTok Ads ad-account id from ads tiktok accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads tiktok ad-groups`](/docs/cli/commands/ads/tiktok/ad-groups): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/tiktok/advertisements -->

# `smallforce ads tiktok advertisements`

Create and manage TikTok advertisements and Spark Ads

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads tiktok advertisements --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce ads tiktok advertisements list`](/docs/cli/commands/ads/tiktok/advertisements/list): List TikTok advertisements
- [`smallforce ads tiktok advertisements get`](/docs/cli/commands/ads/tiktok/advertisements/get): Read one TikTok advertisement
- [`smallforce ads tiktok advertisements update`](/docs/cli/commands/ads/tiktok/advertisements/update): Update a TikTok advertisement
- [`smallforce ads tiktok advertisements delete`](/docs/cli/commands/ads/tiktok/advertisements/delete): Delete a TikTok advertisement
- [`smallforce ads tiktok advertisements status`](/docs/cli/commands/ads/tiktok/advertisements/status): Pause or resume a TikTok advertisement
- [`smallforce ads tiktok advertisements boost`](/docs/cli/commands/ads/tiktok/advertisements/boost): Create a TikTok Spark Ad from an authorized post
- [`smallforce ads tiktok advertisements create`](/docs/cli/commands/ads/tiktok/advertisements/create): Create a standalone TikTok video advertisement
- [`smallforce ads tiktok advertisements analytics`](/docs/cli/commands/ads/tiktok/advertisements/analytics): Read analytics for one TikTok advertisement

## Complete command help

```text
Usage: smallforce ads tiktok advertisements [options] [command]

Create and manage TikTok advertisements and Spark Ads

Options:
  -h, --help                      display help for command

Commands:
  list [options]                  List TikTok advertisements
  get [options] <targetId>        Read one TikTok advertisement
  update [options] <targetId>     Update a TikTok advertisement
  delete [options] <targetId>     Delete a TikTok advertisement
  status [options] <targetId>     Pause or resume a TikTok advertisement
  boost [options] [targetId]      Create a TikTok Spark Ad from an authorized post
  create [options]                Create a standalone TikTok video advertisement
  analytics [options] <targetId>  Read analytics for one TikTok advertisement
  help [command]                  display help for command
```

## Related reference

- [`smallforce ads tiktok`](/docs/cli/commands/ads/tiktok): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/tiktok/advertisements/list -->

# `smallforce ads tiktok advertisements list`

List TikTok advertisements

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads tiktok advertisements list --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads tiktok advertisements list [options]

List TikTok advertisements

Options:
  --account <adAccountId>  SmallForce-local TikTok Ads ad-account id from ads tiktok accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads tiktok advertisements`](/docs/cli/commands/ads/tiktok/advertisements): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/tiktok/advertisements/get -->

# `smallforce ads tiktok advertisements get`

Read one TikTok advertisement

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads tiktok advertisements get --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads tiktok advertisements get [options] <targetId>

Read one TikTok advertisement

Arguments:
  targetId                 SmallForce-local ad id; raw TikTok Ads ids are rejected

Options:
  --account <adAccountId>  SmallForce-local TikTok Ads ad-account id from ads tiktok accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads tiktok advertisements`](/docs/cli/commands/ads/tiktok/advertisements): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/tiktok/advertisements/update -->

# `smallforce ads tiktok advertisements update`

Update a TikTok advertisement

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads tiktok advertisements update --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads tiktok advertisements update [options] <targetId>

Update a TikTok advertisement

Arguments:
  targetId                 SmallForce-local ad id; raw TikTok Ads ids are rejected

Options:
  --account <adAccountId>  SmallForce-local TikTok Ads ad-account id from ads tiktok accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads tiktok advertisements`](/docs/cli/commands/ads/tiktok/advertisements): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/tiktok/advertisements/delete -->

# `smallforce ads tiktok advertisements delete`

Delete a TikTok advertisement

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads tiktok advertisements delete --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads tiktok advertisements delete [options] <targetId>

Delete a TikTok advertisement

Arguments:
  targetId                 SmallForce-local ad id; raw TikTok Ads ids are rejected

Options:
  --account <adAccountId>  SmallForce-local TikTok Ads ad-account id from ads tiktok accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads tiktok advertisements`](/docs/cli/commands/ads/tiktok/advertisements): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/tiktok/advertisements/status -->

# `smallforce ads tiktok advertisements status`

Pause or resume a TikTok advertisement

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads tiktok advertisements status --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads tiktok advertisements status [options] <targetId>

Pause or resume a TikTok advertisement

Arguments:
  targetId                 SmallForce-local ad id; raw TikTok Ads ids are rejected

Options:
  --account <adAccountId>  SmallForce-local TikTok Ads ad-account id from ads tiktok accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads tiktok advertisements`](/docs/cli/commands/ads/tiktok/advertisements): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/tiktok/advertisements/boost -->

# `smallforce ads tiktok advertisements boost`

Create a TikTok Spark Ad from an authorized post

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads tiktok advertisements boost --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads tiktok advertisements boost [options] [targetId]

Create a TikTok Spark Ad from an authorized post

Arguments:
  targetId                 SmallForce-local social_post id; raw TikTok Ads ids are rejected

Options:
  --account <adAccountId>  SmallForce-local TikTok Ads ad-account id from ads tiktok accounts list
  --idempotency-key <key>  Stable mutation key; reuse after a timeout, never generate a new key for
                           an uncertain result
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads tiktok advertisements`](/docs/cli/commands/ads/tiktok/advertisements): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/tiktok/advertisements/create -->

# `smallforce ads tiktok advertisements create`

Create a standalone TikTok video advertisement

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads tiktok advertisements create --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads tiktok advertisements create [options]

Create a standalone TikTok video advertisement

Options:
  --account <adAccountId>  SmallForce-local TikTok Ads ad-account id from ads tiktok accounts list
  --idempotency-key <key>  Stable mutation key; reuse after a timeout, never generate a new key for
                           an uncertain result
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads tiktok advertisements`](/docs/cli/commands/ads/tiktok/advertisements): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/tiktok/advertisements/analytics -->

# `smallforce ads tiktok advertisements analytics`

Read analytics for one TikTok advertisement

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads tiktok advertisements analytics --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads tiktok advertisements analytics [options] <targetId>

Read analytics for one TikTok advertisement

Arguments:
  targetId                 SmallForce-local ad id; raw TikTok Ads ids are rejected

Options:
  --account <adAccountId>  SmallForce-local TikTok Ads ad-account id from ads tiktok accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads tiktok advertisements`](/docs/cli/commands/ads/tiktok/advertisements): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/tiktok/campaigns -->

# `smallforce ads tiktok campaigns`

Inspect and manage TikTok Ads campaigns

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads tiktok campaigns --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce ads tiktok campaigns list`](/docs/cli/commands/ads/tiktok/campaigns/list): List TikTok Ads campaigns
- [`smallforce ads tiktok campaigns status`](/docs/cli/commands/ads/tiktok/campaigns/status): Pause or resume a TikTok Ads campaign
- [`smallforce ads tiktok campaigns bulk-status`](/docs/cli/commands/ads/tiktok/campaigns/bulk-status): Pause or resume several TikTok Ads campaigns
- [`smallforce ads tiktok campaigns duplicate`](/docs/cli/commands/ads/tiktok/campaigns/duplicate): Duplicate a TikTok Ads campaign
- [`smallforce ads tiktok campaigns tree`](/docs/cli/commands/ads/tiktok/campaigns/tree): Read the TikTok Ads campaign tree
- [`smallforce ads tiktok campaigns analytics`](/docs/cli/commands/ads/tiktok/campaigns/analytics): Read TikTok Ads campaign analytics

## Complete command help

```text
Usage: smallforce ads tiktok campaigns [options] [command]

Inspect and manage TikTok Ads campaigns

Options:
  -h, --help                      display help for command

Commands:
  list [options]                  List TikTok Ads campaigns
  status [options] <targetId>     Pause or resume a TikTok Ads campaign
  bulk-status [options]           Pause or resume several TikTok Ads campaigns
  duplicate [options] <targetId>  Duplicate a TikTok Ads campaign
  tree [options]                  Read the TikTok Ads campaign tree
  analytics [options] <targetId>  Read TikTok Ads campaign analytics
  help [command]                  display help for command
```

## Related reference

- [`smallforce ads tiktok`](/docs/cli/commands/ads/tiktok): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/tiktok/campaigns/list -->

# `smallforce ads tiktok campaigns list`

List TikTok Ads campaigns

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads tiktok campaigns list --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads tiktok campaigns list [options]

List TikTok Ads campaigns

Options:
  --account <adAccountId>  SmallForce-local TikTok Ads ad-account id from ads tiktok accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads tiktok campaigns`](/docs/cli/commands/ads/tiktok/campaigns): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/tiktok/campaigns/status -->

# `smallforce ads tiktok campaigns status`

Pause or resume a TikTok Ads campaign

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads tiktok campaigns status --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads tiktok campaigns status [options] <targetId>

Pause or resume a TikTok Ads campaign

Arguments:
  targetId                 SmallForce-local campaign id; raw TikTok Ads ids are rejected

Options:
  --account <adAccountId>  SmallForce-local TikTok Ads ad-account id from ads tiktok accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads tiktok campaigns`](/docs/cli/commands/ads/tiktok/campaigns): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/tiktok/campaigns/bulk-status -->

# `smallforce ads tiktok campaigns bulk-status`

Pause or resume several TikTok Ads campaigns

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads tiktok campaigns bulk-status --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads tiktok campaigns bulk-status [options]

Pause or resume several TikTok Ads campaigns

Options:
  --account <adAccountId>  SmallForce-local TikTok Ads ad-account id from ads tiktok accounts list
  --campaign <campaignId>  SmallForce-local campaign id; repeat for multiple campaigns (default: [])
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads tiktok campaigns`](/docs/cli/commands/ads/tiktok/campaigns): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/tiktok/campaigns/duplicate -->

# `smallforce ads tiktok campaigns duplicate`

Duplicate a TikTok Ads campaign

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads tiktok campaigns duplicate --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads tiktok campaigns duplicate [options] <targetId>

Duplicate a TikTok Ads campaign

Arguments:
  targetId                 SmallForce-local campaign id; raw TikTok Ads ids are rejected

Options:
  --account <adAccountId>  SmallForce-local TikTok Ads ad-account id from ads tiktok accounts list
  --idempotency-key <key>  Stable mutation key; reuse after a timeout, never generate a new key for
                           an uncertain result
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads tiktok campaigns`](/docs/cli/commands/ads/tiktok/campaigns): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/tiktok/campaigns/tree -->

# `smallforce ads tiktok campaigns tree`

Read the TikTok Ads campaign tree

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads tiktok campaigns tree --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads tiktok campaigns tree [options]

Read the TikTok Ads campaign tree

Options:
  --account <adAccountId>  SmallForce-local TikTok Ads ad-account id from ads tiktok accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads tiktok campaigns`](/docs/cli/commands/ads/tiktok/campaigns): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/tiktok/campaigns/analytics -->

# `smallforce ads tiktok campaigns analytics`

Read TikTok Ads campaign analytics

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads tiktok campaigns analytics --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads tiktok campaigns analytics [options] <targetId>

Read TikTok Ads campaign analytics

Arguments:
  targetId                 SmallForce-local campaign id; raw TikTok Ads ids are rejected

Options:
  --account <adAccountId>  SmallForce-local TikTok Ads ad-account id from ads tiktok accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads tiktok campaigns`](/docs/cli/commands/ads/tiktok/campaigns): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/tiktok/insights -->

# `smallforce ads tiktok insights`

Read TikTok Ads performance timelines

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads tiktok insights --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce ads tiktok insights timeline`](/docs/cli/commands/ads/tiktok/insights/timeline): Read TikTok Ads daily performance

## Complete command help

```text
Usage: smallforce ads tiktok insights [options] [command]

Read TikTok Ads performance timelines

Options:
  -h, --help          display help for command

Commands:
  timeline [options]  Read TikTok Ads daily performance
  help [command]      display help for command
```

## Related reference

- [`smallforce ads tiktok`](/docs/cli/commands/ads/tiktok): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/tiktok/insights/timeline -->

# `smallforce ads tiktok insights timeline`

Read TikTok Ads daily performance

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads tiktok insights timeline --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads tiktok insights timeline [options]

Read TikTok Ads daily performance

Options:
  --account <adAccountId>  SmallForce-local TikTok Ads ad-account id from ads tiktok accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads tiktok insights`](/docs/cli/commands/ads/tiktok/insights): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/tiktok/targeting -->

# `smallforce ads tiktok targeting`

Search TikTok Ads targeting options

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads tiktok targeting --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce ads tiktok targeting search`](/docs/cli/commands/ads/tiktok/targeting/search): Search TikTok Ads targeting options

## Complete command help

```text
Usage: smallforce ads tiktok targeting [options] [command]

Search TikTok Ads targeting options

Options:
  -h, --help        display help for command

Commands:
  search [options]  Search TikTok Ads targeting options
  help [command]    display help for command
```

## Related reference

- [`smallforce ads tiktok`](/docs/cli/commands/ads/tiktok): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/tiktok/targeting/search -->

# `smallforce ads tiktok targeting search`

Search TikTok Ads targeting options

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads tiktok targeting search --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads tiktok targeting search [options]

Search TikTok Ads targeting options

Options:
  --account <adAccountId>  SmallForce-local TikTok Ads ad-account id from ads tiktok accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads tiktok targeting`](/docs/cli/commands/ads/tiktok/targeting): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/tiktok/audiences -->

# `smallforce ads tiktok audiences`

Manage TikTok customer-list audiences

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads tiktok audiences --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce ads tiktok audiences list`](/docs/cli/commands/ads/tiktok/audiences/list): List TikTok customer-list audiences
- [`smallforce ads tiktok audiences create`](/docs/cli/commands/ads/tiktok/audiences/create): Create a TikTok customer-list audience
- [`smallforce ads tiktok audiences get`](/docs/cli/commands/ads/tiktok/audiences/get): Read a TikTok customer-list audience
- [`smallforce ads tiktok audiences delete`](/docs/cli/commands/ads/tiktok/audiences/delete): Delete a TikTok customer-list audience
- [`smallforce ads tiktok audiences add-users`](/docs/cli/commands/ads/tiktok/audiences/add-users): Upload members to a TikTok customer-list audience

## Complete command help

```text
Usage: smallforce ads tiktok audiences [options] [command]

Manage TikTok customer-list audiences

Options:
  -h, --help                      display help for command

Commands:
  list [options]                  List TikTok customer-list audiences
  create [options]                Create a TikTok customer-list audience
  get [options] <targetId>        Read a TikTok customer-list audience
  delete [options] <targetId>     Delete a TikTok customer-list audience
  add-users [options] <targetId>  Upload members to a TikTok customer-list audience
  help [command]                  display help for command
```

## Related reference

- [`smallforce ads tiktok`](/docs/cli/commands/ads/tiktok): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/tiktok/audiences/list -->

# `smallforce ads tiktok audiences list`

List TikTok customer-list audiences

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads tiktok audiences list --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads tiktok audiences list [options]

List TikTok customer-list audiences

Options:
  --account <adAccountId>  SmallForce-local TikTok Ads ad-account id from ads tiktok accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads tiktok audiences`](/docs/cli/commands/ads/tiktok/audiences): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/tiktok/audiences/create -->

# `smallforce ads tiktok audiences create`

Create a TikTok customer-list audience

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads tiktok audiences create --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads tiktok audiences create [options]

Create a TikTok customer-list audience

Options:
  --account <adAccountId>  SmallForce-local TikTok Ads ad-account id from ads tiktok accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads tiktok audiences`](/docs/cli/commands/ads/tiktok/audiences): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/tiktok/audiences/get -->

# `smallforce ads tiktok audiences get`

Read a TikTok customer-list audience

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads tiktok audiences get --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads tiktok audiences get [options] <targetId>

Read a TikTok customer-list audience

Arguments:
  targetId                 SmallForce-local audience id; raw TikTok Ads ids are rejected

Options:
  --account <adAccountId>  SmallForce-local TikTok Ads ad-account id from ads tiktok accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads tiktok audiences`](/docs/cli/commands/ads/tiktok/audiences): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/tiktok/audiences/delete -->

# `smallforce ads tiktok audiences delete`

Delete a TikTok customer-list audience

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads tiktok audiences delete --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads tiktok audiences delete [options] <targetId>

Delete a TikTok customer-list audience

Arguments:
  targetId                 SmallForce-local audience id; raw TikTok Ads ids are rejected

Options:
  --account <adAccountId>  SmallForce-local TikTok Ads ad-account id from ads tiktok accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads tiktok audiences`](/docs/cli/commands/ads/tiktok/audiences): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/tiktok/audiences/add-users -->

# `smallforce ads tiktok audiences add-users`

Upload members to a TikTok customer-list audience

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads tiktok audiences add-users --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads tiktok audiences add-users [options] <targetId>

Upload members to a TikTok customer-list audience

Arguments:
  targetId                 SmallForce-local audience id; raw TikTok Ads ids are rejected

Options:
  --account <adAccountId>  SmallForce-local TikTok Ads ad-account id from ads tiktok accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads tiktok audiences`](/docs/cli/commands/ads/tiktok/audiences): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/tiktok/conversions -->

# `smallforce ads tiktok conversions`

Discover destinations and send TikTok conversion events

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads tiktok conversions --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce ads tiktok conversions send`](/docs/cli/commands/ads/tiktok/conversions/send): Send TikTok offline conversion events
- [`smallforce ads tiktok conversions destinations`](/docs/cli/commands/ads/tiktok/conversions/destinations): List TikTok conversion destinations

## Complete command help

```text
Usage: smallforce ads tiktok conversions [options] [command]

Discover destinations and send TikTok conversion events

Options:
  -h, --help                 display help for command

Commands:
  send [options] <targetId>  Send TikTok offline conversion events
  destinations [options]     List TikTok conversion destinations
  help [command]             display help for command
```

## Related reference

- [`smallforce ads tiktok`](/docs/cli/commands/ads/tiktok): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/tiktok/conversions/send -->

# `smallforce ads tiktok conversions send`

Send TikTok offline conversion events

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads tiktok conversions send --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads tiktok conversions send [options] <targetId>

Send TikTok offline conversion events

Arguments:
  targetId                 SmallForce-local conversion_destination id; raw TikTok Ads ids are
                           rejected

Options:
  --account <adAccountId>  SmallForce-local TikTok Ads ad-account id from ads tiktok accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads tiktok conversions`](/docs/cli/commands/ads/tiktok/conversions): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/ads/tiktok/conversions/destinations -->

# `smallforce ads tiktok conversions destinations`

List TikTok conversion destinations

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce ads tiktok conversions destinations --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce ads tiktok conversions destinations [options]

List TikTok conversion destinations

Options:
  --account <adAccountId>  SmallForce-local TikTok Ads ad-account id from ads tiktok accounts list
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce ads tiktok conversions`](/docs/cli/commands/ads/tiktok/conversions): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/seo -->

# `smallforce seo`

Discover and run SEO, local-search, and AI-search research capabilities

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce seo --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce seo tools`](/docs/cli/commands/seo/tools): Discover current SEO research capabilities and input schemas
- [`smallforce seo run`](/docs/cli/commands/seo/run): Reserve credits and submit one asynchronous scraper run
- [`smallforce seo runs`](/docs/cli/commands/seo/runs): List scraper runs and retrieve status or raw items

## Complete command help

```text
Usage: smallforce seo [options] [command]

Discover and run SEO, local-search, and AI-search research capabilities

Options:
  -h, --help                 display help for command

Commands:
  tools                      Discover current SEO research capabilities and input schemas
  run [options] <scraperId>  Reserve credits and submit one asynchronous scraper run
  runs                       List scraper runs and retrieve status or raw items
  help [command]             display help for command
```

## Related reference

- [`smallforce`](/docs/cli/commands): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/seo/tools -->

# `smallforce seo tools`

Discover current SEO research capabilities and input schemas

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce seo tools --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce seo tools search`](/docs/cli/commands/seo/tools/search): Search enabled SEO and AI-search research capabilities by intent

## Complete command help

```text
Usage: smallforce seo tools [options] [command]

Discover current SEO research capabilities and input schemas

Options:
  -h, --help                display help for command

Commands:
  search [options] <query>  Search enabled SEO and AI-search research capabilities by intent
  help [command]            display help for command
```

## Related reference

- [`smallforce seo`](/docs/cli/commands/seo): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/seo/tools/search -->

# `smallforce seo tools search`

Search enabled SEO and AI-search research capabilities by intent

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce seo tools search --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce seo tools search [options] <query>

Search enabled SEO and AI-search research capabilities by intent

Arguments:
  query                Focused SEO capability intent such as keyword, backlinks, or website audit

Options:
  --tag <tag>          Filter by a catalog tag (repeatable) (default: [])
  --limit <n>          Scrapers to return, 1 to 25
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  -h, --help           display help for command
```

## Related reference

- [`smallforce seo tools`](/docs/cli/commands/seo/tools): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/seo/run -->

# `smallforce seo run`

Reserve credits and submit one asynchronous scraper run

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce seo run --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce seo run [options] <scraperId>

Reserve credits and submit one asynchronous scraper run

Arguments:
  scraperId            UUID returned by seo tools search

Options:
  --input <json>       Scraper input JSON matching inputSchema
  --input-file <path>  Scraper input JSON file; use - to read from stdin
  --max-credits <n>    Maximum SmallForce Credits this run may consume
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  -h, --help           display help for command
```

## Related reference

- [`smallforce seo`](/docs/cli/commands/seo): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/seo/runs -->

# `smallforce seo runs`

List scraper runs and retrieve status or raw items

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce seo runs --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce seo runs list`](/docs/cli/commands/seo/runs/list): List organization scraper runs
- [`smallforce seo runs get`](/docs/cli/commands/seo/runs/get): Get one scraper run's status, billing, and submitted input
- [`smallforce seo runs items`](/docs/cli/commands/seo/runs/items): Fetch the result items stored for one scraper run

## Complete command help

```text
Usage: smallforce seo runs [options] [command]

List scraper runs and retrieve status or raw items

Options:
  -h, --help               display help for command

Commands:
  list [options]           List organization scraper runs
  get [options] <runId>    Get one scraper run's status, billing, and submitted input
  items [options] <runId>  Fetch the result items stored for one scraper run
  help [command]           display help for command
```

## Related reference

- [`smallforce seo`](/docs/cli/commands/seo): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/seo/runs/list -->

# `smallforce seo runs list`

List organization scraper runs

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce seo runs list --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce seo runs list [options]

List organization scraper runs

Options:
  --limit <n>            Runs to return, 1 to 100
  --cursor <cursor>      Opaque cursor from the previous page
  --scraper <scraperId>  Filter by SmallForce scraper UUID
  --status <status>      Filter by pending, running, succeeded, failed, aborted, timed_out
  --api-key <key>        SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>    SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                 Print stable machine-readable JSON
  --text                 Print human-readable text
  --format <format>      Output format: text or json
  -h, --help             display help for command
```

## Related reference

- [`smallforce seo runs`](/docs/cli/commands/seo/runs): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/seo/runs/get -->

# `smallforce seo runs get`

Get one scraper run's status, billing, and submitted input

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce seo runs get --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce seo runs get [options] <runId>

Get one scraper run's status, billing, and submitted input

Arguments:
  runId                SmallForce run UUID returned by seo run

Options:
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  -h, --help           display help for command
```

## Related reference

- [`smallforce seo runs`](/docs/cli/commands/seo/runs): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/seo/runs/items -->

# `smallforce seo runs items`

Fetch the result items stored for one scraper run

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce seo runs items --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce seo runs items [options] <runId>

Fetch the result items stored for one scraper run

Arguments:
  runId                SmallForce run UUID returned by seo run

Options:
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  -h, --help           display help for command
```

## Related reference

- [`smallforce seo runs`](/docs/cli/commands/seo/runs): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/scrapers -->

# `smallforce scrapers`

Discover and run curated web and social scrapers

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce scrapers --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce scrapers search`](/docs/cli/commands/scrapers/search): Search the curated scraper catalog by research intent
- [`smallforce scrapers run`](/docs/cli/commands/scrapers/run): Reserve credits and submit one asynchronous scraper run
- [`smallforce scrapers runs`](/docs/cli/commands/scrapers/runs): List scraper runs and retrieve status or raw items

## Complete command help

```text
Usage: smallforce scrapers [options] [command]

Discover and run curated web and social scrapers

Options:
  -h, --help                 display help for command

Commands:
  search [options] [query]   Search the curated scraper catalog by research intent
  run [options] <scraperId>  Reserve credits and submit one asynchronous scraper run
  runs                       List scraper runs and retrieve status or raw items
  help [command]             display help for command
```

## Related reference

- [`smallforce`](/docs/cli/commands): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/scrapers/search -->

# `smallforce scrapers search`

Search the curated scraper catalog by research intent

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce scrapers search --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce scrapers search [options] [query]

Search the curated scraper catalog by research intent

Arguments:
  query                Use case, platform, or content to research

Options:
  --tag <tag>          Filter by a catalog tag (repeatable) (default: [])
  --limit <n>          Scrapers to return, 1 to 25
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  -h, --help           display help for command
```

## Related reference

- [`smallforce scrapers`](/docs/cli/commands/scrapers): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/scrapers/run -->

# `smallforce scrapers run`

Reserve credits and submit one asynchronous scraper run

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce scrapers run --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce scrapers run [options] <scraperId>

Reserve credits and submit one asynchronous scraper run

Arguments:
  scraperId            UUID returned by scrapers search

Options:
  --input <json>       Scraper input JSON matching inputSchema
  --input-file <path>  Scraper input JSON file; use - to read from stdin
  --max-credits <n>    Maximum SmallForce Credits this run may consume
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  -h, --help           display help for command
```

## Related reference

- [`smallforce scrapers`](/docs/cli/commands/scrapers): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/scrapers/runs -->

# `smallforce scrapers runs`

List scraper runs and retrieve status or raw items

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce scrapers runs --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce scrapers runs list`](/docs/cli/commands/scrapers/runs/list): List organization scraper runs
- [`smallforce scrapers runs get`](/docs/cli/commands/scrapers/runs/get): Get one scraper run's status, billing, and submitted input
- [`smallforce scrapers runs items`](/docs/cli/commands/scrapers/runs/items): Fetch the result items stored for one scraper run

## Complete command help

```text
Usage: smallforce scrapers runs [options] [command]

List scraper runs and retrieve status or raw items

Options:
  -h, --help               display help for command

Commands:
  list [options]           List organization scraper runs
  get [options] <runId>    Get one scraper run's status, billing, and submitted input
  items [options] <runId>  Fetch the result items stored for one scraper run
  help [command]           display help for command
```

## Related reference

- [`smallforce scrapers`](/docs/cli/commands/scrapers): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/scrapers/runs/list -->

# `smallforce scrapers runs list`

List organization scraper runs

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce scrapers runs list --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce scrapers runs list [options]

List organization scraper runs

Options:
  --limit <n>            Runs to return, 1 to 100
  --cursor <cursor>      Opaque cursor from the previous page
  --scraper <scraperId>  Filter by SmallForce scraper UUID
  --status <status>      Filter by pending, running, succeeded, failed, aborted, timed_out
  --api-key <key>        SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>    SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                 Print stable machine-readable JSON
  --text                 Print human-readable text
  --format <format>      Output format: text or json
  -h, --help             display help for command
```

## Related reference

- [`smallforce scrapers runs`](/docs/cli/commands/scrapers/runs): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/scrapers/runs/get -->

# `smallforce scrapers runs get`

Get one scraper run's status, billing, and submitted input

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce scrapers runs get --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce scrapers runs get [options] <runId>

Get one scraper run's status, billing, and submitted input

Arguments:
  runId                SmallForce run UUID returned by scrapers run

Options:
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  -h, --help           display help for command
```

## Related reference

- [`smallforce scrapers runs`](/docs/cli/commands/scrapers/runs): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/scrapers/runs/items -->

# `smallforce scrapers runs items`

Fetch the result items stored for one scraper run

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce scrapers runs items --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce scrapers runs items [options] <runId>

Fetch the result items stored for one scraper run

Arguments:
  runId                SmallForce run UUID returned by scrapers run

Options:
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  -h, --help           display help for command
```

## Related reference

- [`smallforce scrapers runs`](/docs/cli/commands/scrapers/runs): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/gmb -->

# `smallforce gmb`

Manage Google Business Profile locations, media, actions, and analytics

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce gmb --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce gmb accounts`](/docs/cli/commands/gmb/accounts): Discover connected Google Business accounts and location IDs
- [`smallforce gmb locations`](/docs/cli/commands/gmb/locations): Read and update a Google Business location
- [`smallforce gmb photos`](/docs/cli/commands/gmb/photos): List, add, and delete Google Business photos
- [`smallforce gmb actions`](/docs/cli/commands/gmb/actions): Manage Google Business place-action links
- [`smallforce gmb analytics`](/docs/cli/commands/gmb/analytics): Inspect Google Business performance and search discovery

## Complete command help

```text
Usage: smallforce gmb [options] [command]

Manage Google Business Profile locations, media, actions, and analytics

Options:
  -h, --help      display help for command

Commands:
  accounts        Discover connected Google Business accounts and location IDs
  locations       Read and update a Google Business location
  photos          List, add, and delete Google Business photos
  actions         Manage Google Business place-action links
  analytics       Inspect Google Business performance and search discovery
  help [command]  display help for command
```

## Related reference

- [`smallforce`](/docs/cli/commands): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/gmb/accounts -->

# `smallforce gmb accounts`

Discover connected Google Business accounts and location IDs

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce gmb accounts --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce gmb accounts list`](/docs/cli/commands/gmb/accounts/list): List accessible Google Business accounts and locations

## Complete command help

```text
Usage: smallforce gmb accounts [options] [command]

Discover connected Google Business accounts and location IDs

Options:
  -h, --help      display help for command

Commands:
  list [options]  List accessible Google Business accounts and locations
  help [command]  display help for command
```

## Related reference

- [`smallforce gmb`](/docs/cli/commands/gmb): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/gmb/accounts/list -->

# `smallforce gmb accounts list`

List accessible Google Business accounts and locations

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce gmb accounts list --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce gmb accounts list [options]

List accessible Google Business accounts and locations

Options:
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  -h, --help           display help for command
```

## Related reference

- [`smallforce gmb accounts`](/docs/cli/commands/gmb/accounts): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/gmb/locations -->

# `smallforce gmb locations`

Read and update a Google Business location

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce gmb locations --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce gmb locations get`](/docs/cli/commands/gmb/locations/get): Get the current details for one Google Business location
- [`smallforce gmb locations update`](/docs/cli/commands/gmb/locations/update): Update selected fields on one Google Business location

## Complete command help

```text
Usage: smallforce gmb locations [options] [command]

Read and update a Google Business location

Options:
  -h, --help                                    display help for command

Commands:
  get [options] <accountId> <destinationId>     Get the current details for one Google Business
                                                location
  update [options] <accountId> <destinationId>  Update selected fields on one Google Business
                                                location
  help [command]                                display help for command
```

## Related reference

- [`smallforce gmb`](/docs/cli/commands/gmb): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/gmb/locations/get -->

# `smallforce gmb locations get`

Get the current details for one Google Business location

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce gmb locations get --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce gmb locations get [options] <accountId> <destinationId>

Get the current details for one Google Business location

Arguments:
  accountId            Account id from gmb accounts list
  destinationId        Location destination id from gmb accounts list

Options:
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  -h, --help           display help for command
```

## Related reference

- [`smallforce gmb locations`](/docs/cli/commands/gmb/locations): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/gmb/locations/update -->

# `smallforce gmb locations update`

Update selected fields on one Google Business location

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce gmb locations update --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce gmb locations update [options] <accountId> <destinationId>

Update selected fields on one Google Business location

Arguments:
  accountId                     Account id from gmb accounts list
  destinationId                 Location destination id from gmb accounts list

Options:
  --description <text>          Business description; pass an empty string to clear it
  --website-url <url>           Website URL; pass an empty string to clear it
  --primary-phone <phone>       Primary phone; replaces the complete phone group
  --additional-phone <phone>    Additional phone; repeat for multiple values (default: [])
  --primary-category <name>     Google category resource name, for example
                                categories/gcid:restaurant
  --additional-category <name>  Additional category resource name; repeatable (default: [])
  --regular-hours <json>        Regular-hours object; exact shape documented below
  --special-hours <json>        Special-hours object; exact shape documented below
  --api-key <key>               SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>           SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                        Print stable machine-readable JSON
  --text                        Print human-readable text
  --format <format>             Output format: text or json
  -h, --help                    display help for command
```

## Related reference

- [`smallforce gmb locations`](/docs/cli/commands/gmb/locations): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/gmb/photos -->

# `smallforce gmb photos`

List, add, and delete Google Business photos

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce gmb photos --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce gmb photos list`](/docs/cli/commands/gmb/photos/list): List photos for one Google Business location
- [`smallforce gmb photos add`](/docs/cli/commands/gmb/photos/add): Publish an uploaded SmallForce asset as a Google Business photo
- [`smallforce gmb photos delete`](/docs/cli/commands/gmb/photos/delete): Delete one Google Business photo

## Complete command help

```text
Usage: smallforce gmb photos [options] [command]

List, add, and delete Google Business photos

Options:
  -h, --help                                              display help for command

Commands:
  list [options] <accountId> <destinationId>              List photos for one Google Business
                                                          location
  add [options] <accountId> <destinationId>               Publish an uploaded SmallForce asset as a
                                                          Google Business photo
  delete [options] <accountId> <destinationId> <photoId>  Delete one Google Business photo
  help [command]                                          display help for command
```

## Related reference

- [`smallforce gmb`](/docs/cli/commands/gmb): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/gmb/photos/list -->

# `smallforce gmb photos list`

List photos for one Google Business location

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce gmb photos list --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce gmb photos list [options] <accountId> <destinationId>

List photos for one Google Business location

Arguments:
  accountId            Account id from gmb accounts list
  destinationId        Location destination id from gmb accounts list

Options:
  --limit <number>     Number of photos to return, 1-100
  --cursor <cursor>    Continuation cursor from the previous response
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  -h, --help           display help for command
```

## Related reference

- [`smallforce gmb photos`](/docs/cli/commands/gmb/photos): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/gmb/photos/add -->

# `smallforce gmb photos add`

Publish an uploaded SmallForce asset as a Google Business photo

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce gmb photos add --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce gmb photos add [options] <accountId> <destinationId>

Publish an uploaded SmallForce asset as a Google Business photo

Arguments:
  accountId              Account id from gmb accounts list
  destinationId          Location destination id from gmb accounts list

Options:
  --asset <assetId>      Asset id returned by assets upload
  --category <category>  Google photo category; defaults according to provider behavior
  --description <text>   Optional photo description, maximum 1500 characters
  --api-key <key>        SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>    SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                 Print stable machine-readable JSON
  --text                 Print human-readable text
  --format <format>      Output format: text or json
  -h, --help             display help for command
```

## Related reference

- [`smallforce gmb photos`](/docs/cli/commands/gmb/photos): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/gmb/photos/delete -->

# `smallforce gmb photos delete`

Delete one Google Business photo

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce gmb photos delete --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce gmb photos delete [options] <accountId> <destinationId> <photoId>

Delete one Google Business photo

Arguments:
  accountId            Account id from gmb accounts list
  destinationId        Location destination id from gmb accounts list
  photoId              Photo id from gmb photos list

Options:
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  -h, --help           display help for command
```

## Related reference

- [`smallforce gmb photos`](/docs/cli/commands/gmb/photos): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/gmb/actions -->

# `smallforce gmb actions`

Manage Google Business place-action links

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce gmb actions --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce gmb actions list`](/docs/cli/commands/gmb/actions/list): List place-action links for one location
- [`smallforce gmb actions create`](/docs/cli/commands/gmb/actions/create): Create a place-action link
- [`smallforce gmb actions update`](/docs/cli/commands/gmb/actions/update): Update the type or URL of one place action
- [`smallforce gmb actions delete`](/docs/cli/commands/gmb/actions/delete): Delete one Google Business place action

## Complete command help

```text
Usage: smallforce gmb actions [options] [command]

Manage Google Business place-action links

Options:
  -h, --help                                               display help for command

Commands:
  list [options] <accountId> <destinationId>               List place-action links for one location
  create [options] <accountId> <destinationId>             Create a place-action link
  update [options] <accountId> <destinationId> <actionId>  Update the type or URL of one place
                                                           action
  delete [options] <accountId> <destinationId> <actionId>  Delete one Google Business place action
  help [command]                                           display help for command
```

## Related reference

- [`smallforce gmb`](/docs/cli/commands/gmb): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/gmb/actions/list -->

# `smallforce gmb actions list`

List place-action links for one location

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce gmb actions list --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce gmb actions list [options] <accountId> <destinationId>

List place-action links for one location

Arguments:
  accountId            Account id from gmb accounts list
  destinationId        Location destination id from gmb accounts list

Options:
  --limit <number>     Number of actions to return, 1-100
  --cursor <cursor>    Continuation cursor from the previous response
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  -h, --help           display help for command
```

## Related reference

- [`smallforce gmb actions`](/docs/cli/commands/gmb/actions): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/gmb/actions/create -->

# `smallforce gmb actions create`

Create a place-action link

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce gmb actions create --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce gmb actions create [options] <accountId> <destinationId>

Create a place-action link

Arguments:
  accountId            Account id from gmb accounts list
  destinationId        Location destination id from gmb accounts list

Options:
  --type <type>        Place-action type
  --url <url>          Public action URL, maximum 2048 characters
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  -h, --help           display help for command
```

## Related reference

- [`smallforce gmb actions`](/docs/cli/commands/gmb/actions): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/gmb/actions/update -->

# `smallforce gmb actions update`

Update the type or URL of one place action

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce gmb actions update --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce gmb actions update [options] <accountId> <destinationId> <actionId>

Update the type or URL of one place action

Arguments:
  accountId            Account id from gmb accounts list
  destinationId        Location destination id from gmb accounts list
  actionId             Action id from gmb actions list

Options:
  --type <type>        New place-action type
  --url <url>          New public action URL
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  -h, --help           display help for command
```

## Related reference

- [`smallforce gmb actions`](/docs/cli/commands/gmb/actions): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/gmb/actions/delete -->

# `smallforce gmb actions delete`

Delete one Google Business place action

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce gmb actions delete --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce gmb actions delete [options] <accountId> <destinationId> <actionId>

Delete one Google Business place action

Arguments:
  accountId            Account id from gmb accounts list
  destinationId        Location destination id from gmb accounts list
  actionId             Action id from gmb actions list

Options:
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  -h, --help           display help for command
```

## Related reference

- [`smallforce gmb actions`](/docs/cli/commands/gmb/actions): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/gmb/analytics -->

# `smallforce gmb analytics`

Inspect Google Business performance and search discovery

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce gmb analytics --help` locally to view the same reference for your installed version.

## Subcommands

- [`smallforce gmb analytics performance`](/docs/cli/commands/gmb/analytics/performance): Get daily Google Business performance metrics
- [`smallforce gmb analytics search-keywords`](/docs/cli/commands/gmb/analytics/search-keywords): Get search keywords that surfaced one Google Business location

## Complete command help

```text
Usage: smallforce gmb analytics [options] [command]

Inspect Google Business performance and search discovery

Options:
  -h, --help                                             display help for command

Commands:
  performance [options] <accountId> <destinationId>      Get daily Google Business performance
                                                         metrics
  search-keywords [options] <accountId> <destinationId>  Get search keywords that surfaced one
                                                         Google Business location
  help [command]                                         display help for command
```

## Related reference

- [`smallforce gmb`](/docs/cli/commands/gmb): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/gmb/analytics/performance -->

# `smallforce gmb analytics performance`

Get daily Google Business performance metrics

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce gmb analytics performance --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce gmb analytics performance [options] <accountId> <destinationId>

Get daily Google Business performance metrics

Arguments:
  accountId             Account id from gmb accounts list
  destinationId         Location destination id from gmb accounts list

Options:
  --start <YYYY-MM-DD>  Inclusive start date
  --end <YYYY-MM-DD>    Inclusive end date
  --metric <metric>     Metric to request; repeatable (default: [])
  --api-key <key>       SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>   SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                Print stable machine-readable JSON
  --text                Print human-readable text
  --format <format>     Output format: text or json
  -h, --help            display help for command
```

## Related reference

- [`smallforce gmb analytics`](/docs/cli/commands/gmb/analytics): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.

---

<!-- source: cli/commands/gmb/analytics/search-keywords -->

# `smallforce gmb analytics search-keywords`

Get search keywords that surfaced one Google Business location

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run `smallforce gmb analytics search-keywords --help` locally to view the same reference for your installed version.

## Complete command help

```text
Usage: smallforce gmb analytics search-keywords [options] <accountId> <destinationId>

Get search keywords that surfaced one Google Business location

Arguments:
  accountId                Account id from gmb accounts list
  destinationId            Location destination id from gmb accounts list

Options:
  --start-month <YYYY-MM>  Inclusive first month
  --end-month <YYYY-MM>    Inclusive last month
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command
```

## Related reference

- [`smallforce gmb analytics`](/docs/cli/commands/gmb/analytics): Parent command and related operations.
- [CLI installation and authentication](/docs/cli/getting-started): Install the CLI and configure an API key.
- [CLI JSON output](/docs/cli/json-output): Use stable machine-readable output in scripts and agents.