arkai 0.8.0__tar.gz

arkai-0.8.0/LICENSE

@@ -0,0 +1,184 @@
+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 in 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 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, including any additions to
+that work or derivative works thereof (as defined 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, thus including
+but not limited to any source code and object code modifications,
+processing of the Work in its entirety, as part of a larger work.
+However, works that merely link (or bind by name) to the interfaces of,
+the Work and Derivative Works thereof do not make the Derivative
+Works a derivative work of the Work, unless the link occurs on behalf
+of the Work. For the purposes of this definition, a work of
+authorship, including the Work, shall not be deemed modified by
+including it.
+
+"Contribution" shall mean any work of authorship, including
+the original Work and any Derivative Works thereof, that
+intentionally submits, displays, performs, publishes, distributes,
+or otherwise makes available to Licensor or any third party any
+Source or Object form of the Work. For the purposes of this definition,
+a Contribution does not include (i) Source code or Object form of the
+Work that is solely for development purposes, or (ii) communications
+intended for development purposes.
+
+"Contributor" shall mean Licensor and any 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) for infringement
+of a patent, then the patent licenses granted to this License to that
+entity 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, 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 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 of this License.
+
+5. Submission of Contributions.
+
+Unless You explicitly state otherwise, any Contribution intentionally
+submitted for inclusion in the Work by You to 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 Contribution.
+
+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

arkai-0.8.0/PKG-INFO

@@ -0,0 +1,112 @@
+Metadata-Version: 2.4
+Name: arkai
+Version: 0.8.0
+Summary: Local AI inference workflow management
+Author: arkai contributors
+License: Apache License 2.0
+Requires-Python: <3.15,>=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: PyYAML>=6.0
+Requires-Dist: requests>=2.28.0
+Provides-Extra: rag
+Requires-Dist: chromadb<2.0,>=1.0.0; extra == "rag"
+Requires-Dist: pymupdf>=1.23.0; extra == "rag"
+Requires-Dist: markdown>=3.4; extra == "rag"
+Requires-Dist: sentence-transformers>=2.2.0; extra == "rag"
+Provides-Extra: mlx
+Requires-Dist: mlx-lm>=0.20.0; extra == "mlx"
+Provides-Extra: keychain
+Requires-Dist: keyring>=24.0.0; extra == "keychain"
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Requires-Dist: behave>=1.2.6; extra == "dev"
+Requires-Dist: ruff>=0.1.0; extra == "dev"
+Requires-Dist: ty>=0.0.74; extra == "dev"
+Requires-Dist: coverage[toml]>=7.10; extra == "dev"
+Requires-Dist: packaging; extra == "dev"
+Dynamic: license-file
+
+# arkai
+
+Arkai is a command-line tool for running coding agents with local AI
+models. It connects an agent to an inference server and can manage MCP
+tools and sandboxed execution for a project. Cloud providers are also
+supported when you prefer not to run inference locally.
+
+Use Arkai when you want one command to start an agent with a selected
+model and the supporting services it needs.
+
+## Requirements
+
+- Python 3.10–3.14
+- `git` for Git-backed model downloads; Hugging Face repositories with
+  large weight files may also require Git LFS.
+- For local inference, an installed inference backend. The default is
+  `llama-server` from [llama.cpp](https://github.com/ggml-org/llama.cpp).
+- An installed supported agent CLI, such as OpenCode, Crush, Claude Code,
+  Codex, Pi, or OMP.
+- For the default sandboxed and MCP-enabled agent workflow, `arapuca` and
+  `wtmcp`. Both integrations can be skipped for a run, but doing so
+  removes sandbox protection or MCP tools respectively.
+
+## Install
+
+You can install from PyPI:
+
+```bash
+python -m pip install arkai
+```
+
+To install from the GitHub repository:
+
+```bash
+git clone https://github.com/LeGambiArt/arkai.git
+cd arkai
+python3.14 -m venv .venv
+source .venv/bin/activate
+python -m pip install .
+```
+
+Optional extras are described in the [user guides](docs/guides).
+
+## Start using Arkai
+
+Download a model and start an agent (this example skips MCP and
+sandboxing, so use it only in a workspace you trust):
+
+```bash
+arkai model download hf:ibm-granite/granite-4.1-8b-GGUF
+arkai agent start \
+  --agent opencode \
+  --model hf:ibm-granite/granite-4.1-8b-GGUF \
+  --no-mcp \
+  --no-sandbox
+```
+
+This requires `llama-server` and the OpenCode CLI to be installed. For
+the sandboxed, MCP-enabled workflow, install `arapuca` and `wtmcp`, then
+omit `--no-mcp` and `--no-sandbox`. Arkai can also start a configured
+agent with `arkai agent start`; use `arkai --help` to explore commands.
+
+To create a project configuration and validate it:
+
+```bash
+arkai config init
+# Edit .arkai.yaml, for example to set inference.model.
+arkai config validate
+```
+
+For troubleshooting, put `--debug` before the command, for example
+`arkai --debug agent start`.
+
+## More
+
+- [User guides](https://github.com/LeGambiArt/arkai/tree/main/docs/guides) —
+  configuration, models, agents, sandboxing, plugins, and RAG.
+- [Design documents](https://github.com/LeGambiArt/arkai/tree/main/docs/design) —
+  architecture and implementation details, one feature per document.
+- [Contributing](https://github.com/LeGambiArt/arkai/blob/main/CONTRIBUTING.
+md)
+
+Arkai is licensed under [Apache 2.0](https://github.com/LeGambiArt/arkai/blob/main/LICENSE).

arkai-0.8.0/README.md

@@ -0,0 +1,83 @@
+# arkai
+
+Arkai is a command-line tool for running coding agents with local AI
+models. It connects an agent to an inference server and can manage MCP
+tools and sandboxed execution for a project. Cloud providers are also
+supported when you prefer not to run inference locally.
+
+Use Arkai when you want one command to start an agent with a selected
+model and the supporting services it needs.
+
+## Requirements
+
+- Python 3.10–3.14
+- `git` for Git-backed model downloads; Hugging Face repositories with
+  large weight files may also require Git LFS.
+- For local inference, an installed inference backend. The default is
+  `llama-server` from [llama.cpp](https://github.com/ggml-org/llama.cpp).
+- An installed supported agent CLI, such as OpenCode, Crush, Claude Code,
+  Codex, Pi, or OMP.
+- For the default sandboxed and MCP-enabled agent workflow, `arapuca` and
+  `wtmcp`. Both integrations can be skipped for a run, but doing so
+  removes sandbox protection or MCP tools respectively.
+
+## Install
+
+You can install from PyPI:
+
+```bash
+python -m pip install arkai
+```
+
+To install from the GitHub repository:
+
+```bash
+git clone https://github.com/LeGambiArt/arkai.git
+cd arkai
+python3.14 -m venv .venv
+source .venv/bin/activate
+python -m pip install .
+```
+
+Optional extras are described in the [user guides](docs/guides).
+
+## Start using Arkai
+
+Download a model and start an agent (this example skips MCP and
+sandboxing, so use it only in a workspace you trust):
+
+```bash
+arkai model download hf:ibm-granite/granite-4.1-8b-GGUF
+arkai agent start \
+  --agent opencode \
+  --model hf:ibm-granite/granite-4.1-8b-GGUF \
+  --no-mcp \
+  --no-sandbox
+```
+
+This requires `llama-server` and the OpenCode CLI to be installed. For
+the sandboxed, MCP-enabled workflow, install `arapuca` and `wtmcp`, then
+omit `--no-mcp` and `--no-sandbox`. Arkai can also start a configured
+agent with `arkai agent start`; use `arkai --help` to explore commands.
+
+To create a project configuration and validate it:
+
+```bash
+arkai config init
+# Edit .arkai.yaml, for example to set inference.model.
+arkai config validate
+```
+
+For troubleshooting, put `--debug` before the command, for example
+`arkai --debug agent start`.
+
+## More
+
+- [User guides](https://github.com/LeGambiArt/arkai/tree/main/docs/guides) —
+  configuration, models, agents, sandboxing, plugins, and RAG.
+- [Design documents](https://github.com/LeGambiArt/arkai/tree/main/docs/design) —
+  architecture and implementation details, one feature per document.
+- [Contributing](https://github.com/LeGambiArt/arkai/blob/main/CONTRIBUTING.
+md)
+
+Arkai is licensed under [Apache 2.0](https://github.com/LeGambiArt/arkai/blob/main/LICENSE).

arkai-0.8.0/arkai/__init__.py

@@ -0,0 +1,3 @@
+"""arkai: Local AI inference workflow management."""
+
+__version__ = "0.1.0"

arkai-0.8.0/arkai/__main__.py

@@ -0,0 +1,6 @@
+"""Entry point for arkai package."""
+
+from arkai.cli import main
+
+if __name__ == "__main__":
+    main()