fadenstack 0.4.2__tar.gz

fadenstack-0.4.2/.gitignore

@@ -0,0 +1,39 @@
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.egg-info/
+dist/
+build/
+*.egg
+.eggs/
+*.spec
+
+# Virtual environment
+.venv/
+venv/
+env/
+
+# uv
+uv.lock
+
+# IDE
+.idea/
+.vscode/
+*.swp
+*.swo
+
+# OS
+.DS_Store
+Thumbs.db
+
+# Testing
+.coverage
+htmlcov/
+.pytest_cache/
+
+# mypy
+.mypy_cache/
+
+# ruff
+.ruff_cache/

fadenstack-0.4.2/LICENSE

@@ -0,0 +1,187 @@
+                                 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.

fadenstack-0.4.2/NOTICE

@@ -0,0 +1,15 @@
+   Fadenstack CLI
+
+   Copyright 2026 Emagin8 UG (haftungsbeschränkt) and contributors.
+
+   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.

fadenstack-0.4.2/OFFICIAL.md

@@ -0,0 +1,9 @@
+# Brand and Official Releases
+
+This repository is the upstream project for "Fadenstack" CLI.
+
+- You may fork and modify the code under the Apache 2.0 License.
+- Please do not present modified forks as the official "Fadenstack" project.
+- Please do not use the Fadenstack name or logo in a way that implies endorsement or an official relationship.
+
+Official releases are published only from this GitHub organization/repository.

fadenstack-0.4.2/PKG-INFO

@@ -0,0 +1,304 @@
+Metadata-Version: 2.5
+Name: fadenstack
+Version: 0.4.2
+Summary: CLI installer and management tool for the Fadenstack platform
+Project-URL: Homepage, https://fadenstack.github.io
+Project-URL: Repository, https://github.com/fadenstack/fadenstack
+Project-URL: Documentation, https://fadenstack.github.io/docs
+Project-URL: Issues, https://github.com/fadenstack/fadenstack/issues
+Author-email: Sachith Liyanagama <liyanagama@outlook.de>
+Maintainer-email: Sachith Liyanagama <liyanagama@outlook.de>
+License-Expression: Apache-2.0
+License-File: LICENSE
+License-File: NOTICE
+Keywords: ai,cli,docker,infrastructure,llm
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: System Administrators
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: System :: Installation/Setup
+Classifier: Topic :: System :: Systems Administration
+Requires-Python: <4.0,>=3.12
+Requires-Dist: click<9,>=8.1
+Requires-Dist: cryptography>=43
+Requires-Dist: httpx<1,>=0.27
+Requires-Dist: inquirerpy<1,>=0.3
+Requires-Dist: jinja2<4,>=3.1
+Requires-Dist: packaging>=23
+Requires-Dist: psutil<7,>=6.0
+Requires-Dist: pyyaml<7,>=6.0
+Requires-Dist: rich<14,>=13.0
+Requires-Dist: textual<2,>=1.0
+Description-Content-Type: text/markdown
+
+# Fadenstack
+
+[![PyPI version](https://img.shields.io/pypi/v/fadenstack)](https://pypi.org/project/fadenstack/)
+[![Python 3.12+](https://img.shields.io/pypi/pyversions/fadenstack)](https://pypi.org/project/fadenstack/)
+[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://github.com/fadenstack/fadenstack/blob/main/cli/LICENSE)
+
+The single entry point to **deploy, configure, and manage** the
+[fadenstack](https://fadenstack.com) platform — an open-source LLM gateway
+that routes, secures, and observes traffic across local runtimes and remote
+providers.
+
+```
+pipx install fadenstack       # or: uv tool install fadenstack
+faden deploy                 # installs Fadenstack into ~/fadenstack and starts it
+```
+
+The CLI carries the deployment files of its release and runs that release's
+published images: `fadenstack 0.4.2` deploys Fadenstack 0.4.2. To upgrade,
+upgrade the CLI and run `faden upgrade`. See
+[Installing Fadenstack](https://github.com/fadenstack/fadenstack/blob/main/docs/help/pages/operate/installing.md).
+
+---
+
+## Features
+
+- **One-command production deploy** — pre-flight checks, `.env` generation,
+  the release's images, database migrations, and service startup.
+- **Upgrade, backup and restore** — `faden upgrade` backs up every database,
+  moves the install to the CLI's release and keeps your settings.
+- **Auto-tuning** — detects host CPU / RAM and computes optimal worker counts,
+  DB pool sizes, and queue channel pools.
+- **Module management** — enable / disable optional services
+  (PII redaction, MCP tools, skills) via Docker Compose profiles.
+- **GPU detection** — `faden doctor` lists the host's GPUs; `faden deploy`
+  adds the NVIDIA GPU overlay when the host has an NVIDIA runtime.
+- **Developer workflow** — clone all repos, install deps, run infra + migrations,
+  and generate a VS Code workspace in one command.
+- **Rich terminal UI** — tables, progress bars, and themed output powered by
+  [Rich](https://github.com/Textualize/rich).
+- **Command abbreviation** — type `faden st` instead of `faden status`.
+
+---
+
+## Requirements
+
+| Dependency     | Minimum |
+| -------------- | ------- |
+| Python         | 3.12    |
+| Docker Engine  | 24.0    |
+| Docker Compose | v2      |
+
+Git is only needed to deploy from a source checkout (`--build`) or for the
+developer workflow.
+
+---
+
+## Installation
+
+### From PyPI
+
+```bash
+pip install fadenstack
+
+# or with uv
+uv tool install fadenstack
+```
+
+### From source
+
+```bash
+git clone https://github.com/fadenstack/fadenstack.git
+cd fadenstack/cli
+uv sync                   # install deps + editable entry point
+uv run faden --help
+```
+
+### Verify
+
+```bash
+faden version
+faden doctor
+```
+
+---
+
+## Quick start
+
+### Production deployment
+
+```bash
+# Full deploy — pre-flight, env gen, pull this release's images, migrate, start
+faden deploy                      # into ~/fadenstack
+faden deploy /opt/faden         # into a directory of your choice
+
+# Enable optional modules
+faden deploy --modules pii,mcp
+
+# From a source checkout: build the images instead of pulling them
+faden deploy --build
+
+# Upgrade to the CLI's release (backs up first), back up, restore
+faden upgrade
+faden backup
+faden restore ~/fadenstack/backups/<time>
+
+# Provision node-agent on this host during deploy
+faden deploy /opt/faden --local-node
+
+# Provision node-agent on remote host over SSH
+faden deploy /opt/faden --local-node --local-node-host ubuntu@10.0.0.12
+```
+
+### Day-to-day operations
+
+```bash
+faden up                          # start all services
+faden up --build faden-gateway     # rebuild a single service
+faden down                        # stop all services
+faden down --volumes              # stop + remove volumes
+faden status                      # service table
+faden logs -f                     # tail all logs
+faden logs -f faden-backend    # tail one service
+```
+
+### Modules
+
+```bash
+faden module list                 # show available modules
+faden module enable pii skills    # enable modules
+faden module disable mcp          # disable a module
+```
+
+### Configuration
+
+```bash
+faden config show                 # print current config
+faden config set dev.branch main  # update a value (dot-notation)
+faden config edit                 # open in $EDITOR
+faden config path                 # print config file location
+```
+
+### Auto-tuning
+
+```bash
+faden tune                        # detect resources, write .env
+faden tune --profile prod         # production-grade sizing
+faden tune --dry-run              # preview without writing
+```
+
+### Admin utilities
+
+```bash
+faden admin reset-password --email admin@localhost
+```
+
+### Developer workflow
+
+```bash
+# Bootstrap everything — clone repos, install deps, start infra,
+# run migrations, generate VS Code workspace
+faden dev init ~/projects/fadenstack
+faden dev init ~/projects/fadenstack --ssh        # SSH cloning
+faden dev init ~/projects/fadenstack --overwrite   # re-clone existing repos
+
+# Start / stop / status
+faden dev up                            # on this machine only (127.0.0.1)
+faden dev up --lan                      # on every interface, for one run
+faden dev up --backend-only
+faden dev up --modules pii,mcp,skills   # also run the optional modules
+faden dev up --local-node
+faden dev up --local-node --local-node-host ubuntu@10.0.0.12
+faden dev down
+faden dev status
+
+# Check dev prerequisites (optionally auto-install missing tools)
+faden dev doctor
+faden dev doctor --install --yes
+```
+
+`--modules` runs PII (8003), MCP (8007) and skills (8008) on the host beside
+the backend, and points the gateway and backend at them. Without it, the
+modules switched on with `faden module enable` run; the others are switched
+off in the gateway and backend. See
+[What happens to a request](../docs/help/pages/administer/requests.md).
+
+`--local-node` installs a systemd unit by default and requires sudo on Linux.
+Use `--local-node-no-sudo` to skip privileged systemd setup.
+
+---
+
+## Command reference
+
+| Command                                      | Description                                                   |
+| -------------------------------------------- | ------------------------------------------------------------- |
+| `faden version`                            | Print CLI, Python, Docker, and Compose versions               |
+| `faden doctor`                             | Run system health checks (OS, RAM, disk, Docker, GPU, ports)  |
+| `faden deploy [DIR]`                       | Full production deployment with pre-flight checks             |
+| `faden upgrade`                            | Back up, move to the CLI's release, restart with health gate  |
+| `faden backup` / `faden restore DIR`     | Dump every database and `.env` / put them back                |
+| `faden maintenance on\|off\|status`       | Show the maintenance page instead of the platform (`-m` note) |
+| `faden deploy [DIR] --local-node`          | Deploy + provision node-agent (local or SSH host)            |
+| `faden up [SERVICES...]`                   | Start services (supports `--build`, `--pull`)                 |
+| `faden down`                               | Stop and remove containers (`--volumes`, `--all`)             |
+| `faden status`                             | Show service state, health, and ports (`--json`)              |
+| `faden logs [SERVICES...]`                 | Stream logs (`-f`, `-n`, `--timestamps`)                      |
+| `faden config show\|set\|edit\|path\|init` | Manage YAML configuration                                     |
+| `faden module list\|enable\|disable`       | Toggle optional platform modules                              |
+| `faden tune`                               | Auto-tune worker and pool settings (`--profile`, `--dry-run`) |
+| `faden admin reset-password`               | Reset a user password directly in the database                |
+| `faden dev init [DIR]`                     | Bootstrap full developer workspace                            |
+| `faden dev up`                             | Start backend, worker, gateway, and frontend dev servers      |
+| `faden dev up --lan`                       | The same, reachable from the network (dev mode signs anyone in as admin) |
+| `faden dev up --modules pii,mcp,skills`    | Also run the optional modules on the host                     |
+| `faden dev up --local-node`                | Start dev services and provision node-agent                   |
+| `faden dev down`                           | Stop all dev processes                                        |
+| `faden dev status`                         | Show repo branches, infra, and dev processes                  |
+| `faden dev doctor`                         | Check dev prerequisites (`--install`)                         |
+
+---
+
+## Project structure
+
+```
+cli/
+├── pyproject.toml
+├── src/
+│   └── faden_cli/
+│       ├── cli.py                 # Click root group + AliasedGroup
+│       ├── commands/
+│       │   ├── version.py         # version
+│       │   ├── doctor.py          # doctor
+│       │   ├── deploy.py          # deploy
+│       │   ├── up.py              # up
+│       │   ├── down.py            # down
+│       │   ├── status.py          # status
+│       │   ├── logs_cmd.py        # logs
+│       │   ├── config.py          # config group
+│       │   ├── module.py          # module group
+│       │   ├── tune.py            # tune
+│       │   ├── admin.py           # admin group
+│       │   └── dev/               # developer workflow
+│       │       ├── dev_init.py
+│       │       ├── dev_up.py
+│       │       ├── dev_status.py
+│       │       └── dev_doctor.py
+│       ├── core/                  # shared utilities
+│       │   ├── compose.py         # Docker Compose wrapper
+│       │   ├── detect.py          # OS / GPU / port detection
+│       │   ├── settings.py        # YAML config (~/.config/faden/)
+│       │   ├── api_client.py      # Backend REST client (httpx)
+│       │   ├── bootstrap.py       # First-admin bootstrap
+│       │   ├── env_gen.py         # .env generation (Jinja2)
+│       │   ├── git.py             # Git clone / checkout helpers
+│       │   ├── install.py         # Cross-platform tool installer
+│       │   ├── registry.py        # Central metadata registry
+│       │   ├── sysinfo.py         # Resource detection + tuning
+│       │   └── console.py         # Rich themed output
+│       ├── tui/                   # Textual TUI wizard
+│       └── templates/             # Jinja2 .env templates
+└── tests/
+```
+
+---
+
+## License
+
+Apache License 2.0 — see [LICENSE](LICENSE) for details.
+
+Part of the [fadenstack](https://github.com/fadenstack) project.