agentleFS
indranilbanerjeeindranilbanerjee/socialforge/skills/setup/SKILL.md

setup

Skill43 starsChanged 4 months agoMITView on GitHub

One-time setup of image and video generation credentials, verified before use. \"set up my API keys\"

  • Reads credentials

191 other projects use a version of this.

Adopted by

Most recently taken up by

Used with

Projects with it also use add-voice-transcription, add-discord and 10 more.

Other files people use alongside this one.

Files found in the same public projects as a version of this one, more often than they turn up anywhere else. Each project counts once, large collections count for less, and this file's own repository is left out.
  • juancruzmunozalbeloSkill

    add-voice-transcription

    Add voice message transcription to NanoClaw using OpenAI's Whisper API. Automatically transcribes WhatsApp voice notes so the agent can read and respond to them.

    Also in 5 projects that use this

  • MicrosoftSkill

    add-discord

    Add Discord bot channel integration via Chat SDK.

    Also in 11 projects that use this

  • MicrosoftSkill

    add-slack

    Add Slack channel integration via Chat SDK.

    Also in 11 projects that use this

  • juancruzmunozalbeloSkill

    add-telegram-swarm

    Add Agent Swarm (Teams) support to Telegram. Each subagent gets its own bot identity in the group. Requires Telegram channel to be set up first (use /add-telegram). Triggers on "agent swarm", "agent teams telegram", "telegram swarm", "bot pool".

    Also in 7 projects that use this

  • +8 more from microsoft

The file

Show its rules and text

We split this skill into the rules it gives an agent

20 rules. 0 are common, 19 are distinctive, and 1 is very specific to this project.

  • 0

    Common

    Most of the 170 edited versions we read keep these.

  • 19

    Distinctive

    This author's own choices. Worth a look.

  • 1

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  • could be automatic: a setting could enforce it
  1. Distinctive:

    If you are the admin, see the Admin Setup section below.

    line 32
  2. Distinctive:

    Run this first. It only REPORTS which packages are present and prints the exact pinned install command for each one that is missing.

    line 44
  3. Very specific:

    Only on an explicit yes, run:

    line 58
  4. Distinctive:

    Check if already configured:

    line 68
  5. Distinctive:

    If not configured, ask:

    line 73
  6. Distinctive:

    When user provides the path:

    line 84
  7. Distinctive:

    If you are setting up the cloud accounts for your team, follow these detailed guides.

    line 179
  8. Distinctive:

    If you don't have an account, click "Get started for free" and follow registration

    line 185
  9. Distinctive:

    Wait for the project to be created (30 seconds), then select it from the dropdown

    line 190
  10. Distinctive:

    If you don't have a billing account, click "CREATE BILLING ACCOUNT"

    line 195
  11. Distinctive:

    Add a payment method (credit card)

    line 196
  12. Distinctive:

    Search for "Vertex AI API"

    line 201
  13. Distinctive:

    Wait for it to activate (takes a few seconds)

    line 203
  14. Distinctive:

    NEVER commit this file to Git.

    line 231
  15. Distinctive:

    After logging in, go to your dashboard

    line 243
  16. Distinctive:

    Add credits (minimum top-up required to activate API access)

    line 245
  17. Distinctive:

    NEVER commit this key to Git or paste it in public forums.

    line 260
  18. Distinctive:

    Cost: All video generation costs go to the admin's WaveSpeed account.

    line 262
  19. Distinctive:

    Create a new API key pair — you'll get an API Key AND an API Secret

    line 275
  20. Distinctive:

    No credentials are committed to git or shared outside the local machine.

    line 288

“Common” is measured: kept by at least 6 in 10 of the 170 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

/socialforge:setup — API Credential Configuration

Script location. If your host does not set ${CLAUDE_PLUGIN_ROOT}, the scripts are in this plugin's scripts/ folder, next to skills/. Run them with Python 3.10 or newer: python, or python3 where python is not found (macOS, many Linux systems).

One-time setup that records where each credential lives. A key kept in an environment variable is never written anywhere: setup records the variable name and the scripts read the value each time. See Security Notes for what is stored where.

Context efficiency

Asset-heavy skill. Grep before Read the asset catalog (${CLAUDE_PLUGIN_DATA}/socialforge/brands/<brand>/asset-index.json) — never list the asset directory. Reference generated images / videos by path, not by loading metadata. Brand profile loads once per session.

What This Does

Configures two services that SocialForge needs for creative production:

  1. Google Cloud Vertex AI (required for images) — the image models, resolved at run time from the registry aliases latest-image-balanced-google and latest-image-google
  2. WaveSpeed (required for video) — image-to-video, resolved from the registry alias latest-video-wavespeed

Prerequisites

Your admin provides you with:

  • A Google Cloud service account JSON file (for image generation)
  • A WaveSpeed API key (for video generation)

If you are the admin, see the Admin Setup section below.

How to Run

/socialforge:setup

Interactive Flow

Step 0: Check Dependencies (nothing installs without your yes)

Run this first. It only REPORTS which packages are present and prints the exact pinned install command for each one that is missing; it installs nothing:

python "${CLAUDE_PLUGIN_ROOT}/scripts/install_deps.py"

Packages it checks by default (every version is pinned in scripts/install_deps.py): Pillow (compositing), google-genai (Vertex AI), wavespeed and imageio-ffmpeg (video), playwright (carousels; its Chromium browser is a large download).

Show the user the list, then ask:

These packages are missing: <list>. Install them now with the pinned versions? (yes / no)
  Playwright's browser (for carousels) is a large download; say so if playwright is on the list.

Only on an explicit yes, run:

python "${CLAUDE_PLUGIN_ROOT}/scripts/install_deps.py" --install

Any other answer: print the pinned commands from the report for the user to run themselves, and continue.

Extra packages are never part of that default and are installed only when the user asks for them by name: HiggsField's client (--groups higgsfield), background removal, which fetches model weights on first use (--groups background-removal), C2PA signing (--groups c2pa), and OS keychain support (--groups keyring), which lets a key you type or pipe in be kept in the keychain instead of a plain-text file.

Step 1: Image Generation (Vertex AI)

Check if already configured:

python "${CLAUDE_PLUGIN_ROOT}/scripts/credential_manager.py" status

If not configured, ask:

Image Generation Setup (Google Cloud Vertex AI)

Do you have a Google Cloud service account JSON file?
  Provide the full file path (e.g., C:\Users\you\Downloads\socialforge-credentials.json)

Or type "skip" to configure later (image generation will not work).

When user provides the path:

python "${CLAUDE_PLUGIN_ROOT}/scripts/credential_manager.py" setup-vertex --json-path "<user-provided-path>"

The script records the file's PATH and uses the file where it is; it makes no copy. Tell the user to keep the file there, readable only by them. If the result carries warnings about an older SocialForge copy (gcp-credentials.json, made before 1.31.0), show it: that copy is no longer used, and deleting it is the user's call.

Show the result. If success:

Image generation configured.
  Project: <project_id>
  Service Account: <email>
  Models: resolved at run time from the registry (aliases latest-image-balanced-google, latest-image-google)

Step 2: Video Generation (WaveSpeed)

Video Generation Setup (WaveSpeed)

Do you have a WaveSpeed API key?
  Do NOT paste it here: anything typed into this chat is stored in the conversation transcript.
  Set it as the environment variable WAVESPEED_API_KEY (in your shell or your host's environment
  settings) and tell me when it is set.

Or type "skip" to configure later (video generation will not work).

When the user says it is set, run the command below. The script reads WAVESPEED_API_KEY and records only the variable name; the key itself is never written, and it is read from the environment each time a video is made. --api-key is refused with exit 2 (a key on the command line lands in shell history and the process table). The script never reads stdin on its own, so with no key it stops at once with exit 2 (no key: set WAVESPEED_API_KEY, or use --api-key-stdin) instead of waiting: tell the user the variable is not visible to this shell and ask them to set it where the host can see it.

If the variable cannot stay set across sessions, the user can store the key once from their own terminal with --prompt (a hidden prompt, real terminal only); --api-key-stdin reads one line from stdin. A key given either way goes to the OS keychain when keyring is installed (--groups keyring above), and otherwise to credentials.json in plain text, with a warning in the result: show that warning to the user.

python "${CLAUDE_PLUGIN_ROOT}/scripts/credential_manager.py" setup-wavespeed

Show the result. If success:

Video generation configured.
  Provider: WaveSpeed (alias latest-video-wavespeed)
  Models: image-to-video, text-to-video (3-15 seconds)

Step 2.5: HiggsField (Optional Fallback)

HiggsField Setup (Optional — adds fallback resilience)

Do you have a HiggsField API key and secret?
  Do NOT paste them here. Set the environment variables HF_API_KEY and HF_API_SECRET and tell me
  when they are set.

Or type "skip" (HiggsField is optional — Vertex AI and WaveSpeed are sufficient).

When the user says both are set, run the command below. It reads HF_API_KEY and HF_API_SECRET and records only the variable names; --api-key and --api-secret are refused with exit 2. It never reads stdin on its own, so with either missing it stops at once with exit 2. --api-key-stdin reads the key from the first stdin line and the secret from the second, and stores them like the WaveSpeed key (keychain, else the file with a warning).

python "${CLAUDE_PLUGIN_ROOT}/scripts/credential_manager.py" setup-higgsfield

Step 3: Summary

SocialForge API Setup Complete

  Image Generation: [configured / not configured]
    Provider: Google Cloud Vertex AI
    Project: <project_id>
    Models: registry aliases latest-image-balanced-google, latest-image-google

  Video Generation: [configured / not configured]
    Provider: WaveSpeed (alias latest-video-wavespeed)
    Modes: image-to-video, text-to-video

  HiggsField: [configured / skipped]
    Provider: HiggsField (fallback)

  Credentials recorded. Keys in environment variables are read from the environment each run,
  so keep those variables set; nothing else needs setting up again.

  Next: /socialforge:brand-setup [brand-name] to configure your first brand.

Arguments

ArgumentEffect
(none)Run full interactive setup
--imageConfigure image generation only (Vertex AI)
--videoConfigure video generation only (WaveSpeed)
--fallbackConfigure HiggsField fallback only
--statusShow current configuration status
--resetRemove all stored credentials and start fresh

Admin Setup Guide

If you are setting up the cloud accounts for your team, follow these detailed guides.

Google Cloud (Vertex AI — Image Generation)

Step 1: Create a Google Cloud Project

  1. Open https://console.cloud.google.com/
  2. If you don't have an account, click "Get started for free" and follow registration
  3. Click the project dropdown at the top of the page (next to "Google Cloud")
  4. Click "NEW PROJECT"
  5. Enter a project name (e.g., "socialforge-production")
  6. Click "CREATE"
  7. Wait for the project to be created (30 seconds), then select it from the dropdown

Step 2: Enable Billing

  1. Go to https://console.cloud.google.com/billing
  2. Click "LINK A BILLING ACCOUNT"
  3. If you don't have a billing account, click "CREATE BILLING ACCOUNT"
  4. Add a payment method (credit card)
  5. New accounts may come with promotional credits — the console states the current offer and its expiry. This skill does not quote it, because a number stated from memory is wrong the moment the vendor changes it.

Step 3: Enable Vertex AI API

  1. Go to https://console.cloud.google.com/apis/library
  2. Search for "Vertex AI API"
  3. Click on it, then click "ENABLE"
  4. Wait for it to activate (takes a few seconds)

Step 4: Create a Service Account

  1. Go to https://console.cloud.google.com/iam-admin/serviceaccounts
  2. Click "+ CREATE SERVICE ACCOUNT"
  3. Service account name: socialforge-image-gen
  4. Description: SocialForge AI image generation
  5. Click "CREATE AND CONTINUE"
  6. In "Grant this service account access to project":
    • Click the "Select a role" dropdown
    • Type "Vertex AI User" in the search box
    • Select "Vertex AI User"
  7. Click "CONTINUE", then "DONE"

Step 5: Download the JSON Key File

  1. In the service accounts list, click on socialforge-image-gen
  2. Go to the "KEYS" tab
  3. Click "ADD KEY" then "Create new key"
  4. Select "JSON" and click "CREATE"
  5. A .json file downloads automatically — this is your credential file
  6. Save it somewhere safe on your computer

Step 6: Share with Your Team

Share the downloaded JSON file with your team via:

  • Slack DM (not in a public channel)
  • Email (encrypted if possible)
  • Shared company drive (restricted access)

NEVER commit this file to Git. NEVER share it publicly.

Cost: this skill does not state a price. Per-image cost depends on model and resolution and changes without notice, so quoting one here would be a number nobody looked up. Run python "${CLAUDE_PLUGIN_ROOT}/scripts/price_book.py" --action lookup --model <model> --provider <provider>; it returns a recorded price or refuses with the vendor's own pricing URL. All costs go to the admin's billing account.

WaveSpeed (Video Generation)

Step 1: Create a WaveSpeed Account

  1. Open https://wavespeed.ai
  2. Click "Sign Up" and create an account
  3. Verify your email

Step 2: Add Credits

  1. After logging in, go to your dashboard
  2. Click "Top Up" or navigate to billing
  3. Add credits (minimum top-up required to activate API access)
  4. Pricing: read the current per-second rate from the vendor's billing page. This skill deliberately does not quote it — see price_book.py, which refuses to quote a price it has not looked up rather than repeating a stale one.

Step 3: Create an API Key

  1. Go to https://wavespeed.ai/accesskey
  2. Click "Create API Key"
  3. Copy the key (it's a long string of letters and numbers)
  4. Save it somewhere safe

Step 4: Share with Your Team

Share the API key string with your team via:

  • Slack DM
  • Password manager (recommended)
  • Email (encrypted if possible)

NEVER commit this key to Git or paste it in public forums.

Cost: All video generation costs go to the admin's WaveSpeed account. Monitor usage at https://wavespeed.ai/dashboard

HiggsField (Optional Fallback — Video + Image)

HiggsField provides additional resilience. If both Vertex AI and WaveSpeed are down, HiggsField can generate images and videos.

Step 1: Create a HiggsField Account

  1. Open https://higgsfield.ai
  2. Click "Sign Up" and create an account
  3. Any promotional credit for new accounts is shown at signup; this skill does not quote an amount.

Step 2: Get API Credentials

  1. Log in at https://cloud.higgsfield.ai and open the API / Developer section of your dashboard
  2. Create a new API key pair — you'll get an API Key AND an API Secret
  3. Save both values

Step 3: Share with Your Team

Share both the API key AND secret with your team. Both are needed for authentication.

Security Notes

  • credentials.json in the plugin data folder (or ~/socialforge-workspace/) records where each credential lives. For a key in an environment variable it holds only the variable name: the key is never written, and the scripts read it from the environment each time.
  • The GCP service-account JSON is used where you keep it: setup records its path and makes no copy. Keep the file there and readable only by you. Setup before 1.31.0 copied it to gcp-credentials.json; that copy is no longer used and is reported by status until you delete it.
  • A key given through --api-key-stdin or --prompt goes to the OS keychain (Windows Credential Manager, macOS Keychain, the Secret Service on Linux) when the optional keyring package is installed and has a working backend. Without one it is written to credentials.json in plain text, and the result and status say so.
  • File permissions: on macOS and Linux the files are chmod 600. On Windows chmod does nothing useful (it only sets the read-only flag), so setup also runs icacls <file> /inheritance:r /grant:r <you>:F, which removes inherited access and leaves only your account. If that fails, the result says so. An administrator of the machine can still read any file.
  • Keys are never taken through the chat or the command line: --api-key and --api-secret exit 2. Only environment variables, or an explicit --api-key-stdin / --prompt, are read. A script never reads stdin on its own, so a missing key fails at once instead of hanging the shell.
  • No credentials are committed to git or shared outside the local machine.
  • To revoke access: rotate the service account key in GCP Console or regenerate the WaveSpeed API key.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.