fcloud-sdk 0.1.0__tar.gz

fcloud_sdk-0.1.0/CHANGELOG.md

@@ -0,0 +1,90 @@
+# Changelog
+
+All notable changes to the `fcloud` Python SDK and CLI are recorded here.
+
+## Unreleased
+
+- Renamed: the package is `fcloud-sdk`, the import is `fcloud`, the CLI is
+  `fcloud`, env vars are `FCLOUD_*`, config lives in `~/.fcloud`, project
+  files are `fcloud.json`, new keys are `fcloud_sk_…`, and the client sends
+  `X-Fcloud-Client*` headers. Everything old keeps working: `import foom`,
+  the `foom` command, `FOOM_*`, `~/.foom`, `foom.json`, `foom_sk_` keys and
+  `foom.FoomError`. Map tasks now receive `FCLOUD_TASK_ID` /
+  `FCLOUD_WORLD_SIZE` / `FCLOUD_JOB` (the `FOOM_*` names are gone).
+The format follows [Keep a Changelog](https://keepachangelog.com/en/1.1.0/);
+versions follow [Semantic Versioning](https://semver.org/).
+
+## [Unreleased]
+
+### Added
+- `foom sweep harvest <name> <remote-glob> <local-dir>` — download every
+  task's matching outputs in one command. Sessions are resolved from the
+  sweep and local paths are task-keyed (`<local-dir>/task-<index>/<path>`,
+  or `--flat`), replacing the per-sweep script that parsed status JSON for
+  session ids and ran N `foom download` calls. `--all-states` includes
+  failed and canceled tasks.
+- `foom sweep status --watch [--interval S]` — the human live view,
+  repainted in place until the sweep is terminal. Appends instead of
+  repainting when stdout is not a terminal.
+- `foom stop --wait [--timeout SECONDS]` — block until the workspace
+  manifest is durable, instead of polling `foom sessions` for `state=cold`.
+  `foom map --from <sid>` needs that manifest; the default timeout is 300s
+  and the command exits 1 if the wait expires (the stop itself stands).
+- The `foom sweep status --json` document is now a documented, versioned
+  contract (`schema_version: 1`) — see `docs/sweep-status-schema.md`.
+  Additive changes keep the version; a removal or rename bumps it.
+- Every request now carries `X-Foom-Client` / `X-Foom-Client-Version`, and a
+  client below the deployment's supported floor is rejected with HTTP 426 and
+  the new `foom.ClientTooOldError`, which names the upgrade command. This
+  replaces the previous failure mode for a stale client, an S3
+  `SignatureDoesNotMatch` on every >5 MiB upload that read as a credential
+  problem.
+
+### Changed
+- `foom upload` now names the files that take the pre-signed cloud-storage
+  path (>5 MiB) rather than only the total, and names them again in the error
+  when that path fails — so a broken large-file upload is attributable to a
+  file, not to the command. `Session.upload()` returns them as `s3_files`
+  alongside `inline_files` and `s3_threshold_bytes`.
+
+## [0.1.0] — first public release
+
+### Added
+- `foom` CLI: sessions, exec/run/shell/ssh/tunnel, background processes
+  (spawn/wait/logs/kill), file transfer (upload/download/ls/mount), volumes,
+  run-to-completion jobs, and `foom map` sweeps.
+- Python SDK: `Client`, `Project`, `Session`, `Job`, `SweepHandle`, `Image`.
+- `foom setup` installs the agent skill (`SKILL.md`) for Cursor, Claude Code
+  and Codex.
+- `foom --version` and `foom.__version__`.
+- Directory uploads skip hidden entries, dependency/cache directories and
+  symlinked files by default; `--include-hidden` / `--follow-symlinks` (CLI)
+  and `include_hidden=` / `follow_symlinks=` (SDK) opt back in.
+- `FOOM_TELEMETRY=0` disables the best-effort CLI crash report.
+
+### Removed
+Relative to the pre-release internal SDK (nothing here was ever on PyPI):
+- Public names `MigrationInfo`, `MigrationStatus`, `SyncProgress`, the
+  `FcloudError` and `JobHandle` aliases (`FoomError` / `SweepHandle` remain),
+  and the `Session.migrate()` / `Client.watch()` / `Client.list_session_files()`
+  / `Client.download_file()` helpers — the operator-initiated migration
+  surface is not part of the public client.
+- `Image.add_local_file()`, `Image.add_local_dir()`, `Image.copy()`,
+  `Image.workdir()` — use `Session.upload()` / `foom upload` for local files
+  and the `workdir=` argument on exec.
+- Legacy `~/.fcloud/token`, `~/.fcloud/url` and `fcloud.json` lookups
+  (`~/.foom/*` and `foom.json` are the supported forms). `FCLOUD_API_KEY` /
+  `FCLOUD_URL` are still accepted as aliases of `FOOM_API_KEY` / `FOOM_URL`.
+- Internal modules `foom.upload`, `foom.stream`, `foom.jobs`, `foom.client_ext`
+  and the `s3_uploader` / `websockets_transport` providers, with the
+  `websockets` dependency they pulled in.
+- `DirectClient.run_streaming()` (no callers). `DirectClient.execute()` is
+  kept — internal harnesses use it.
+
+### Security
+- Only `FOOM_*` keys from a project `.env` are imported into the process
+  environment; other keys stay reachable by name via `--secret KEY`.
+- A plaintext (`ws://`) host address is refused when the API was reached over
+  `https://`; a plaintext API URL to a non-local host warns.
+- `foom ssh` quotes its ProxyCommand and validates the session id before using
+  it in filesystem paths.

fcloud_sdk-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,37 @@
+# Contributing
+
+Thanks for your interest in `fcloud`.
+
+## Development setup
+
+```bash
+cd packages/fcloud-sdk
+python3 -m venv .venv && source .venv/bin/activate
+pip install -e ".[dev]"
+```
+
+## Before you open a pull request
+
+```bash
+ruff check src tests      # lint (rule set in pyproject.toml)
+mypy                      # type-check src/fcloud (config in pyproject.toml)
+pytest                    # ~640 hermetic tests, no network or credentials needed
+```
+
+- Keep changes focused; one topic per PR.
+- New behaviour comes with a test — the tests are the spec.
+- Comments explain *why*, not *what*. Please don't reference internal ticket
+  numbers, incidents or environments in code comments.
+- Public functions and classes have docstrings.
+- Line length is 100.
+
+## Reporting bugs
+
+Open a GitHub issue with the `fcloud --version` output, the command or code you
+ran, and what you expected. For anything security-related, see
+[SECURITY.md](SECURITY.md) instead.
+
+## License
+
+By contributing you agree that your contributions are licensed under the
+Apache License 2.0 (see [LICENSE](LICENSE)).

fcloud_sdk-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

fcloud_sdk-0.1.0/MANIFEST.in

@@ -0,0 +1,8 @@
+include README.md
+include LICENSE
+include NOTICE
+include CHANGELOG.md
+include CONTRIBUTING.md
+include SKILL.md
+graft tests
+global-exclude __pycache__ *.py[cod] .DS_Store

fcloud_sdk-0.1.0/NOTICE

@@ -0,0 +1,4 @@
+fcloud
+Copyright 2026 fcloud
+
+This product includes software developed for the fcloud compute platform.

fcloud_sdk-0.1.0/PKG-INFO

@@ -0,0 +1,234 @@
+Metadata-Version: 2.4
+Name: fcloud-sdk
+Version: 0.1.0
+Summary: Python SDK and CLI for the fcloud GPU compute platform
+Author: fcloud
+License-Expression: Apache-2.0
+Keywords: gpu,cloud,compute,ml,training,cli
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+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 :: Libraries :: Python Modules
+Classifier: Topic :: System :: Distributed Computing
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: NOTICE
+Requires-Dist: aiohttp>=3.9
+Requires-Dist: requests>=2.31
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0; extra == "dev"
+Requires-Dist: pytest-xdist>=3.5; extra == "dev"
+Requires-Dist: ruff>=0.8; extra == "dev"
+Requires-Dist: mypy>=1.10; extra == "dev"
+Requires-Dist: types-requests; extra == "dev"
+Dynamic: license-file
+
+# fcloud
+
+Python SDK and CLI for the fcloud GPU compute platform: provision GPU or CPU
+hosts, run commands and scripts on them, keep a persistent workspace between
+runs, move files in and out, and drive long-running or batch jobs — from a
+terminal, from Python, or from an AI coding agent.
+
+Requires Python 3.10+.
+
+## Install
+
+```bash
+pip install fcloud-sdk
+```
+
+Or from a checkout of this repository:
+
+```bash
+cd packages/fcloud-sdk
+pip install -e .          # editable: `git pull` picks up SDK updates
+```
+
+## Setup
+
+You need a fcloud API key. Save it once (it is written to `~/.fcloud/token` with
+mode 0600 and never printed):
+
+```bash
+fcloud setup            # prompts for the key; optionally installs the agent skill
+fcloud health           # verify connectivity
+```
+
+`fcloud setup --agents all` also installs the fcloud skill file for supported
+coding agents (Cursor, Claude Code, Codex) so an agent can drive fcloud for you.
+Use `--agents none` to skip that.
+
+## Quick start
+
+```bash
+# Run a one-off command on a GPU
+fcloud exec --sku gpu_1x_l4 nvidia-smi -L
+
+# Upload a script and run it
+fcloud run train.py --sku gpu_1x_l4
+
+# Upload a project directory, run one script in it, pass arguments through
+fcloud run . --script train.py --sku gpu_1x_l4 -- --epochs 50
+
+# See what hardware is available
+fcloud skus
+```
+
+`fcloud run <dir>` uploads the whole directory. Keep secrets, virtualenvs and
+large data out of the tree you point it at.
+
+## How the pieces fit
+
+- **session** — a persistent `/workspace` filesystem, not a held GPU. It costs
+  nothing until used; `exec`/`run`/`shell`/`upload` bring it online with its
+  files intact, and `fcloud stop` halts spend but keeps the files. Address an
+  existing one with `--on <SID>`.
+- **volume** — a named folder you mount into a session with `--volume`; this is
+  how data moves between sessions. Writes commit back as a new version when the
+  session detaches or closes.
+- **process** — work running inside a session. `exec`/`run` wait in the
+  foreground; `spawn` returns a process id you then `wait`/`logs`/`kill`.
+- **job** — a run-to-completion session with no saved filesystem; its durable
+  outputs are its volumes and its logs.
+- **sweep** — `fcloud map` fans one command out over many argument bindings as a
+  durable batch you inspect with `fcloud sweep`.
+
+## CLI
+
+`fcloud help` prints the full grouped list; `fcloud help <command>` prints details.
+
+```
+Find hardware
+  fcloud skus                                          List SKUs and prices
+  fcloud health                                        Check API connectivity
+
+Run code
+  fcloud exec [--sku SKU] [--on SID] <cmd...>          Run a command on a host
+  fcloud run <file|dir> [--sku SKU] [--on SID]         Upload and run a script
+  fcloud shell [--sku SKU] [--on SID] [--volume NAME]  Interactive shell
+  fcloud ssh <SID>                                     SSH into a session
+  fcloud tunnel <SID> [--port PORT]                    SSH ProxyCommand tunnel
+
+Background processes (inside a session)
+  fcloud spawn --on SID <cmd...>                       Start a background process
+  fcloud wait <SID> <PID> [--timeout DUR]              Wait for it; exit with its code
+  fcloud logs <SID> [PID] [--follow]                   Show process output
+  fcloud kill <SID> <PID>                              Kill it
+
+Sessions (the persistent filesystem)
+  fcloud create [--sku SKU] [--min-disk-gb N]          Create a session ($0 until used)
+  fcloud sessions [SID] [--all] [--limit N]            List sessions
+  fcloud history <SID> [--limit N]                     Session event history
+  fcloud stop <SID>                                    Stop now (files kept)
+
+Files
+  fcloud upload [--on SID] <local> [remote]            Upload files
+  fcloud download [--on SID] <remote> [local]          Download a file
+  fcloud ls <SID> [path]                               List a session's files
+  fcloud mount <SID> <mountpoint>                      Mount session files read-only (needs rclone)
+
+Volumes (data that outlives a session)
+  fcloud volume <create|list|files|download|cat|import|delete> ...
+
+Batch
+  fcloud job <run|ls|logs|wait|kill> ...               Run-to-completion jobs
+  fcloud map [--sku SKU] -- <cmd {}> ::: v1,v2...      Fan a command out over bindings
+  fcloud sweeps / fcloud sweep <status|logs|retry|cancel|wait> <name>
+
+Setup
+  fcloud setup [--token KEY] [--agents all|cursor|claude|codex|none]
+  fcloud set_token <api-key>
+  fcloud --version
+```
+
+All commands accept `--json` for machine-readable output.
+
+`fcloud exec` returns bounded stdout by default. If `--json` reports
+`stdout_truncated: true`, fetch the full log instead of rerunning:
+
+```bash
+fcloud logs <session-id> <process-id> --output all
+fcloud logs <session-id> <process-id> --stream stderr --output all
+```
+
+## Python SDK
+
+```python
+import fcloud
+
+client = fcloud.Client()
+
+image = fcloud.Image.debian_slim().pip_install(["torch", "numpy"])
+project = client.project("my-run", image=image)
+
+with project.session(sku="gpu_1x_l4") as s:
+    s.upload("./data", "data/")
+    result = s.run(["python3", "/workspace/data/train.py"])
+    print(result.stdout)
+    if result.stdout_truncated:
+        print(s.logs(result.process_id, output_range="all").output)
+    weights = s.download("model.pt")
+```
+
+Errors raise `fcloud.FcloudError` (or a subclass such as `PaymentOverdueError`).
+
+## Configuration
+
+API key, in order of precedence:
+
+1. `api_key=` passed to `Client()`
+2. `FCLOUD_API_KEY` exported in the shell
+3. Saved token in `~/.fcloud/token` (from `fcloud setup` / `fcloud set_token`)
+4. `FCLOUD_API_KEY` in the nearest `.env` file (searched upward from the cwd)
+
+API URL, in order of precedence:
+
+1. `url=` passed to `Client()`
+2. `FCLOUD_URL` exported in the shell
+3. Saved URL in `~/.fcloud/url`
+4. `FCLOUD_URL` in the nearest `.env` — only honoured when that same `.env` is
+   also supplying the API key, so a checked-out repo can't redirect a saved
+   token elsewhere
+5. `https://fcloud-dispatcher.fly.dev`
+
+Other environment switches:
+
+| Variable | Effect |
+|---|---|
+| `FCLOUD_QUIET=1` | Suppress "still waiting" progress lines while a host is provisioned |
+| `FCLOUD_QUEUE_TIMEOUT=<seconds>` | How long to wait for capacity before giving up (default 1200) |
+| `FCLOUD_MIGRATE_RESTART=never` | Don't automatically re-run a command after a host rebuild (default `auto`) |
+| `FCLOUD_INSECURE_HTTP=1` | Allow a plaintext `http://` API URL to a non-loopback host (refused by default — the API key would travel unencrypted). Loopback URLs never need this |
+| `FCLOUD_TELEMETRY=0` | Disable all client telemetry. When enabled (the default), the client reports failures the backend cannot otherwise see — an uncaught CLI error, a queue-wait timeout, exhausted connect retries — as a fixed-allowlist payload (session id, event type, error class, truncated message, SKU/timing fields); never file contents, paths from OS errors, or credentials |
+
+A `fcloud.json` at the project root can set defaults (image build steps, default
+volumes). Note that fcloud will run the build steps it finds there, so treat a
+cloned repo's `fcloud.json` the way you would its Dockerfile.
+
+## Agent skill
+
+`fcloud setup --agents all` installs `SKILL.md` for supported coding agents. It
+is the long-form, agent-oriented guide: workflow patterns, monitoring loops,
+and anti-patterns.
+
+## Development
+
+```bash
+pip install -e ".[dev]"
+pytest
+ruff check src tests
+```
+
+## License
+
+Apache License 2.0 — see [LICENSE](LICENSE).