socaity-cli
The command line for the socaity.ai platform: login, catalog browsing,
SDK installs, 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 (stub generation, 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 install <service> |
socaity |
Generate an SDK stub for a service |
socaity update |
socaity |
Sync installed services with the platform |
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 -C DIR with scan/build/start/deploy to point at a service project directory
(e.g. socaity -C 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 |
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 SDK install/update calls.
requires("apipod") guards a function behind an optional package with a friendly
install hint instead of an ImportError traceback.
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file socaity_cli-0.1.1.tar.gz.
File metadata
- Download URL: socaity_cli-0.1.1.tar.gz
- Upload date:
- Size: 25.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
a1296b27d444be189cb96bc42e779ea898fe5e3498a8c90f5bd16842a6f1b5df
|
|
| MD5 |
2ebcae3bcceb09c433c8e1ef2c1748fc
|
|
| BLAKE2b-256 |
a6883d3f2e51361712e7426a8b955dc8e8c7084ac757d3e6717ab8c36c3b7bc4
|
File details
Details for the file socaity_cli-0.1.1-py3-none-any.whl.
File metadata
- Download URL: socaity_cli-0.1.1-py3-none-any.whl
- Upload date:
- Size: 29.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
a365de520558d0cf149153bbf2d4efc0e3f1b57da58a7c0bc4901fa4a36a27ac
|
|
| MD5 |
f9bfdfa6895f2c307db4d589ea3bc964
|
|
| BLAKE2b-256 |
8d02d55c17468d1b0b5e5d677d9ed2218e4cf4ab6e5be853e178a82e59369b80
|
