Skip to content
Socaity Docs

SocaitySDK CLI Reference

The socaity CLI ships with the Python SDK and is what you use to interact with services — log in, install community services, and run quick checks from your terminal.

Installation

The CLI is bundled with the Python SDK. Install it with pip — same package as the SDK.

terminal
pip install socaity

Command Overview

CommandPurposeStatus
socaity -hShow CLI usage and available commands.
Coming Soon
socaity loginIssue a temporary API key and store it locally.
Coming Soon
socaity --install <name>Install an unofficial community service into the local SDK.
Coming Soon

socaity -h / --help

Print the available commands and flags. Always the safest place to start.

terminal
# Planned usage
socaity -h
socaity --help

socaity login

Issues a temporary API key and stores it on disk, similar to gh auth login or claude login. Removes the need to manage SOCAITY_API_KEY by hand for local development.

terminal
# Planned usage — interactive flow, similar to `gh auth login`
socaity login

socaity --install <service_name>

Adds an unofficial / community service to your local SDK so you can import and call it like any official model. This is the bridge between the public service catalogue and your code.

terminal
# Planned usage — install a community service by name
socaity --install some-user/some-service

Use the SDK directly today

While the CLI is being built out, every command above has a Python-level equivalent. For most users, the SDK is already enough.

python
import os
from socaity import face2face

# Authentication — until `socaity login` ships, the SDK reads
# the SOCAITY_API_KEY env var directly.
f2f = face2face(api_key=os.getenv("SOCAITY_API_KEY"))

# Community/unofficial services — until `socaity --install` ships,
# the service manager that syncs official services lives at
# socaity.core.socaity_service_manager.SocaityServiceManager.