socaity-cli
The command line for the socaity.ai platform: login, catalog browsing,
socaity run, and APIPod deployment tooling. One socaity command, shared by the
socaity SDK and APIPod.
The package is deliberately small: httpx and socaity-schemas are the only dependencies.
Commands that need more (SDK run, container builds) delegate to the socaity or
apipod package and tell you what to install when it is missing.
Install
pip install socaity-cli
You get socaity-cli as part of pip install socaity or pip install apipod as well.
Commands
| Command | Needs | What it does |
|---|---|---|
socaity login / logout / whoami |
- | Browser login, credentials in ~/.config/socaity/ |
socaity list services|models |
- | Browse the AI catalog |
socaity search "flux schnel" |
- | Typo-tolerant search (--collections services,models,jobs) |
socaity jobs [job_id] |
login | List/search jobs; --q, --expand data,files,billing,social, --visibility |
socaity projects [project_id] |
login | Your projects; --expand jobs embeds member jobs |
socaity run <target> |
socaity |
Catalog job, agent turn, or workflow run |
socaity connector add <url> |
login | Register a third-party HTTP API (OpenAPI URL, docs page or API root) as a private connector |
socaity scan |
apipod |
Scan a project and generate apipod.json |
socaity build [file] |
apipod |
Build the deployment container |
socaity start [entrypoint] |
apipod |
Run an APIPod service locally |
socaity deploy [target] |
apipod |
Deploy to Socaity (wraps apipod deploy) |
Use --project-dir DIR with scan/build/start/deploy to point at a service project directory
(e.g. socaity --project-dir simple_test_service deploy serverless-runpod --yes).
Configuration
| Env var | Default | Purpose |
|---|---|---|
SOCAITY_API_KEY |
from login | API key (wins over stored credentials) |
SOCAITY_BACKEND_URL |
https://webapi.socaity.ai |
Platform API (env wins; login file is fallback only, never written into the process) |
SOCAITY_FRONTEND_URL |
https://socaity.ai |
Web UI for browser login |
Using it as a library
socaity and apipod build on the same primitives this package exposes:
from socaity_cli import SocaityBackendClient, get_api_key, requires
SocaityBackendClient covers catalog reads, search, and connector registration
(register_connector). Catalog rows are Service models:
details[] holds the spec plus a nested deployment or connector for the
URL. details[0].id is the details_id that pins the spec. Resume a deploy
with deployment_id (details[0].deployment.id).
Connectors are services with kind == "connector".
requires("apipod") guards a function behind an optional package with a friendly
install hint instead of an ImportError traceback.
1 maintainer
Metadata
1 maintainer
Release files for socaity-cli 0.1.10
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| socaity_cli-0.1.10.tar.gz | 43.0 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| socaity_cli-0.1.10-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 93.4 kB
Release files / socaity_cli-0.1.10.tar.gz
| Download URL | socaity_cli-0.1.10.tar.gz |
|---|---|
| Size | 43.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
1343365f3ca6a5141bb0b5186f7834256e803d633d1d2fb164bd8eab77477586
|
|
BLAKE2b-256 checksum How to use checksums |
4514b7423378624496f6e5fa0ebeb9f59ce5a6a9ba088a65c0daa9233b76578f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.12.14
|
Release files / socaity_cli-0.1.10-py3-none-any.whl
| Download URL | socaity_cli-0.1.10-py3-none-any.whl |
|---|---|
| Size | 50.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
942002f408738e2e6469afa4c1eb7efafd6517b39639c9d05b8cff75f4e9cb2a
|
|
BLAKE2b-256 checksum How to use checksums |
e7327b3c867014667e3a077ed143c05c28864d0eaccfa12b72e9018b65181abf
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.12.14
|
