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.

Metadata

Release files for socaity-cli 0.1.11

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for socaity-cli 0.1.11
File	Size	Uploaded
socaity_cli-0.1.11.tar.gz	43.0 kB	Oct 9, 2026	Details

Built distribution (wheel)

Table of built distributions (wheels) for socaity-cli 0.1.11
File	Interpreter	ABI	Platform	Reset
socaity_cli-0.1.11-py3-none-any.whl 50.3 kB Oct 9, 2026	Python 3	none	any	Details

Total release size: 93.3 kB

Release files / socaity_cli-0.1.11.tar.gz

Download URL	socaity_cli-0.1.11.tar.gz
Size	43.0 kB
Tags	Source
SHA-256 checksum How to use checksums	`5dd9129fa1ed9f71d2129928f5a40ad2907bc764df15a7f5f8875f08755b3dcf`
BLAKE2b-256 checksum How to use checksums	`090507de71b012a74e967eaecf76d9d7c762ba32e50abf8f1486272c98d571f9`
Upload date	Oct 9, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/7.0.0 CPython/3.12.15`

Release files / socaity_cli-0.1.11-py3-none-any.whl

Download URL	socaity_cli-0.1.11-py3-none-any.whl
Size	50.3 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`1067fe660ba0ccb4d1c13ba8a9ccb24fbd12684f7fe5036c5be0d844cb5bf005`
BLAKE2b-256 checksum How to use checksums	`38880f07e63c903ebdb35c547d5a711cdc6d63fd427acf98d885544136b66c84`
Upload date	Oct 9, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/7.0.0 CPython/3.12.15`