rathflow-cli 0.1.0__py3-none-any.whl

rathflow_cli-0.1.0.dist-info/METADATA

@@ -0,0 +1,164 @@
+Metadata-Version: 2.4
+Name: rathflow-cli
+Version: 0.1.0
+Summary: RathFlow command line client: sessions, memory, sandboxes, assets and billing over the RathFlow REST API.
+Author: Rath Team
+License-Expression: MIT
+Project-URL: Homepage, https://rathflow.lynwe.com/
+Project-URL: Repository, https://github.com/Rath-Team/rathflow-cli
+Project-URL: Issues, https://github.com/Rath-Team/rathflow-cli/issues
+Project-URL: Changelog, https://github.com/Rath-Team/rathflow-cli/blob/main/CHANGELOG.md
+Keywords: rathflow,cli,agent,sessions,memory,sandbox
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development
+Classifier: Topic :: Utilities
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: httpx>=0.27
+Requires-Dist: typer>=0.12
+Provides-Extra: socks
+Requires-Dist: httpx[socks]; extra == "socks"
+Dynamic: license-file
+
+# rathflow-cli
+
+[![PyPI](https://img.shields.io/pypi/v/rathflow-cli.svg)](https://pypi.org/project/rathflow-cli/)
+[![Python](https://img.shields.io/pypi/pyversions/rathflow-cli.svg)](https://pypi.org/project/rathflow-cli/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
+
+The RathFlow command line client. It talks to the RathFlow northbound REST API and
+covers sessions, memory, sandboxes, agents, assets, projects, billing and
+workflows.
+
+## Install
+
+```bash
+uv tool install rathflow-cli
+# or
+pipx install rathflow-cli
+# or
+pip install rathflow-cli
+```
+
+Requires Python 3.10+.
+
+## Quick start
+
+```bash
+# Log in with your email and password (the password prompt does not echo).
+rathflow auth login -e you@example.com
+
+# Who am I, what can I reach.
+rathflow whoami
+
+# Pick a project scope; every later command carries it.
+rathflow project list
+rathflow project use <project_id>
+
+# Read something.
+rathflow session list
+```
+
+The default gateway is `https://rathflow.lynwe.com`. Point it elsewhere with
+`--base-url`, `RATHFLOW_BASE_URL`, or `rathflow config set base_url <url>`.
+
+## Commands
+
+| Group | What it covers |
+| --- | --- |
+| `auth` | log in / out, register, API keys (`keys`, `key-create`, `key-revoke`) |
+| `config` | local profiles (`list`, `show`, `set`, `use`) |
+| `org` | organizations, invitations |
+| `project` | projects, scope switching, project config, share links |
+| `session` | sessions, blocks, events |
+| `memory` | memory entries, search, commit tasks |
+| `sandbox` | sandboxes, exec, code, files, logs |
+| `agent` | agent definitions, versions, prompts, runs |
+| `asset` | assets, versions, credentials, publish |
+| `billing` | subscription, usage, invoices |
+| `workflow` | workflows |
+| `admin` | platform administration (platform admins only) |
+
+Two more entry points sit at the root:
+
+- `rathflow whoami` — identity, scope and reachable projects.
+- `rathflow api <Key>` — call any endpoint directly; `rathflow api --list` prints
+  the whole table. Streaming endpoints stream.
+
+Every group has `--help`, e.g. `rathflow session --help`.
+
+## Authentication
+
+`rathflow auth login` exchanges your email and password for a JWT, stored in the
+CLI config file (mode `0600`). The CLI sends it as a `Bearer` token and never
+touches cookies, so it is unaffected by the browser CSRF rules.
+
+For unattended use, issue a long-lived API key and pass it through the
+environment:
+
+```bash
+rathflow auth key-create          # prints the key once, right here
+export RATHFLOW_TOKEN=rf_...      # or: rathflow config set token rf_...
+```
+
+## Configuration
+
+Precedence, highest first: command-line flag > environment variable > active
+profile > built-in default. Profiles live in
+`~/.config/rathflow/config.json` (override the directory with
+`RATHFLOW_CONFIG_DIR`).
+
+| Variable | Meaning |
+| --- | --- |
+| `RATHFLOW_BASE_URL` | Gateway address |
+| `RATHFLOW_PROJECT` | Project scope |
+| `RATHFLOW_TOKEN` | Bearer token / API key |
+| `RATHFLOW_CONFIG_DIR` | Config directory |
+
+## Output
+
+- Default: human-readable tables.
+- `--json`: one stable JSON document, for scripts.
+- `--quiet` / `-q`: primary keys only.
+
+Exit codes are stable: `0` success, and non-zero for usage errors, API errors and
+remote command failures (a sandbox `exec` returns the remote exit code).
+
+## Proxies
+
+The CLI respects the standard proxy variables. One caveat: `httpx` cannot use a
+SOCKS proxy unless `socksio` is installed. If your environment sets
+`ALL_PROXY=socks://...` (some Clash setups do), install the extra or the CLI
+fails to start with `Unknown scheme for proxy URL`:
+
+```bash
+uv tool install 'rathflow-cli[socks]'
+# or clear it for this command only
+ALL_PROXY= rathflow whoami
+```
+
+## Development
+
+```bash
+uv venv --python 3.12 .venv
+uv pip install -e .
+.venv/bin/rathflow --help
+.venv/bin/python -m rathflow_cli.selftest
+```
+
+`selftest` checks that no command hard-codes a URL and, when the upstream
+generated endpoint table is available (`RATHFLOW_ENDPOINTS_TS`), that
+`rathflow_cli/endpoints.py` still matches it.
+
+## License
+
+MIT — see [LICENSE](LICENSE).

rathflow_cli-0.1.0.dist-info/RECORD

@@ -0,0 +1,31 @@
+rathflow_cli/__init__.py,sha256=55P6YuPlmnlo_dbK9zoK54PV3pBVRajFUhRAQ969yLU,180
+rathflow_cli/__main__.py,sha256=nKWVfSLFVrKAb_fsVeGdkIdVC6gCmaycpot-JNdnTq0,139
+rathflow_cli/cli.py,sha256=uyOBqV4Vy0U1f662N1GuCWlkOLpOdrsyp4VNk-vFFug,5216
+rathflow_cli/config.py,sha256=Tz-ccTXlIaRZqVAQ3JRglWn0gWMJW3ki1tXWdPfhZss,2155
+rathflow_cli/endpoints.py,sha256=vsA9x2QETIfnE8dj5LFEaFC5mSYyJiUqxBEL7JsJy2Y,10470
+rathflow_cli/errors.py,sha256=xfQMNdT1nrjzqZ_tega0D0HgHGZ1wXW9d7pLC7yD7Yw,2188
+rathflow_cli/http.py,sha256=ykmzPKY6eRjb0A4otBTsujGheAJfX29uVB0Yh8t6idY,11129
+rathflow_cli/output.py,sha256=1kfRl6L13AglUxS-WkRo5TzkPIeUKT2vBxRqdehFBu4,2881
+rathflow_cli/selftest.py,sha256=jdQJr_3lMvX3QFJEtRIE8YveDXR9wnReNP7pPXW3EGM,4748
+rathflow_cli/state.py,sha256=W3NhsL0rqHozeR3Xjiy58tdE7wk2oUQdDQELEcam9yc,4470
+rathflow_cli/commands/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+rathflow_cli/commands/_common.py,sha256=cpvFpeXUZY8HfBRqdE1tIwZG_T-85SguX_1nGk0zO_s,2624
+rathflow_cli/commands/admin.py,sha256=oVkxrbijtAkz8IA6fH2tZHpKxvO5yDRZeu00UhK2LEE,2560
+rathflow_cli/commands/agent.py,sha256=beQ1_4WvlHM6gvsbZpXZYhVTjSwK9LDtDlC2kS3oTnE,9186
+rathflow_cli/commands/api_cmd.py,sha256=dxvnxXAjRLhjbZbT1-wg2w0eSl7KvPhmB3OK46dVz5Y,3060
+rathflow_cli/commands/asset.py,sha256=mRTFDXuO6KayMS_XlV10njWctWojinrP72dy19Lgr0M,14654
+rathflow_cli/commands/auth_cmd.py,sha256=aIhbQ_8KZrmfhAMeWZzNXmxFDjCOFZNMzuaPEWqaUj4,5831
+rathflow_cli/commands/billing.py,sha256=ra8JGIvyAGjmuFVH_R7CPOEOak2Kh7tdfsBNbbxC2IY,2177
+rathflow_cli/commands/config_cmd.py,sha256=lWMyFUbEaoSKlzvHNIV7qJu1VSzocwp2hdUfgJ1-7UA,3063
+rathflow_cli/commands/memory.py,sha256=rM-diDlJwl_UpHtzWn7ZgNpaV_C0neUclkd_foRHmkU,9514
+rathflow_cli/commands/org.py,sha256=Jgfs4Abl0KZBoJ0DUAPznsM0nhVQT0oOo4E3LCRTiK8,2236
+rathflow_cli/commands/project.py,sha256=JeBxdN72MUxigSp07PkGBp3olKYHYuzo8MFb77ROJJA,8319
+rathflow_cli/commands/sandbox.py,sha256=1sbE7wskhvSMd-QWNzKdzB7y0QRDgpaZIQKPTatdbZg,9271
+rathflow_cli/commands/session.py,sha256=9N0OLLtmv_EDG8xdCG_RL3dXviwaFIWJYdWODHjf7rc,7536
+rathflow_cli/commands/workflow.py,sha256=uzqmOlE8UzAty-kjm6enLivs72Ir5mS4rJqx_lveMyo,2364
+rathflow_cli-0.1.0.dist-info/licenses/LICENSE,sha256=Qva3k8Gk9vn181cZczFGgOr6aUwMys0YrbkjmqfEW2c,1066
+rathflow_cli-0.1.0.dist-info/METADATA,sha256=CTeQOa6HEV0HmQCqrskOx6H6ZbmP8QW7BrsfIFZqaqI,5366
+rathflow_cli-0.1.0.dist-info/WHEEL,sha256=YVMoNqKzERt-wjUZwJ33xBGAwnFl-4cqbYkTtWa4itE,91
+rathflow_cli-0.1.0.dist-info/entry_points.txt,sha256=ydDlCW-3Kk8cZqMgz2t-1Jskupjvk75QjcZXoSZlTCs,51
+rathflow_cli-0.1.0.dist-info/top_level.txt,sha256=Htb0EsJ96ExLB9_ZyKt3Q6mcvKucpEvGeRwYZzfmSdY,13
+rathflow_cli-0.1.0.dist-info/RECORD,,

rathflow_cli-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (84.0.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

rathflow_cli-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+rathflow = rathflow_cli.cli:main

rathflow_cli-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Rath Team
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

rathflow_cli-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+rathflow_cli