Metadata-Version: 2.4
Name: praefex-pica
Version: 0.1.5
Summary: Praefex Nexus — The AI That Actually Does Things On Your Computer
Author-email: Praefex <support@praefex.com>
License: MIT
Project-URL: Homepage, https://praefex.com
Project-URL: Documentation, https://praefex.com
Project-URL: Feedback, https://praefex.com/feedback
Project-URL: Bug Tracker, https://praefex.com/feedback
Project-URL: Terms, https://praefex.com/terms
Keywords: ai,agent,automation,llm,praefex,nexus
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: End Users/Desktop
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: click>=8.1
Requires-Dist: flask>=3.0
Requires-Dist: flask-cors>=4.0
Requires-Dist: requests>=2.31
Requires-Dist: psutil>=5.9
Dynamic: license-file

# Praefex Nexus

**The AI that actually does things on your computer.**

Praefex Nexus is a local executor that lets a language model touch your real
files, run real commands, search the web, and reach other machines on your
network. It turns chat-style assistants from "suggesters" into "doers."

```bash
# Install directly from GitHub (recommended)
pip install git+https://github.com/totalvalue/praefex-nexus.git

pica setup
pica start
```

Open the web UI at **http://localhost:7779** or use the CLI directly.

Home: [praefex.com](https://praefex.com) · Feedback: [praefex.com/feedback](https://praefex.com/feedback)

---

## Liability Disclaimer — Read Before Using

> **Praefex Nexus executes real commands on your system.** It runs shell
> commands, reads and writes files, and makes network requests on your behalf.
> By downloading, installing, or using this software, **you accept all
> responsibility** for the actions it takes. **Use entirely at your own risk.**
>
> The developers and maintainers bear **no liability** for data loss, financial
> loss, system damage, unauthorized access, or any other unintended outcome.
>
> Praefex Nexus is provided **"as is"** without warranty of any kind.
>
> Full terms: [praefex.com/terms](https://praefex.com/terms)
>
> If you do not agree, do not install or use this software.

On first run Praefex Nexus will ask you to acknowledge this disclaimer once;
your acknowledgement is recorded in `~/.praefex/pica/config.json`.

---

## Quick Start

```bash
pip install git+https://github.com/totalvalue/praefex-nexus.git  # install
pica setup                          # configure API keys (first run only)
pica start                          # start daemon + web UI on :7779
pica ask "list my desktop files"    # one-shot task from the CLI
pica status                         # check whether the daemon is running
pica stop                           # stop the daemon
```

The web UI shows every tool call (shell command, file read, web search) in the
order it happens, so you can see exactly what Praefex Nexus did.

## Commands

| Command            | What it does                                          |
| ------------------ | ----------------------------------------------------- |
| `pica setup`       | Configure API keys and first-run settings             |
| `pica start`       | Start the background daemon and web UI               |
| `pica stop`        | Stop the daemon                                       |
| `pica status`      | Show whether the daemon is running, PID, memory, CPU |
| `pica ask "..."`   | Run a one-shot task inline                            |
| `pica logs`        | Tail the daemon log                                   |
| `pica autostart`   | Install boot autostart (LaunchAgent / systemd / Task) |
| `pica feedback`    | Open praefex.com/feedback in your browser             |
| `pica --version`   | Show version and disclaimer                           |

## What It Can Do

- **Shell execution** — run any command, capture output, act on the result
- **File operations** — read, write, create, organize, search
- **Web search** — DuckDuckGo lookups with structured results
- **Multi-step tasks** — chains tool calls until the task is done

## Configuration

```bash
pica setup --xai-key YOUR_KEY --non-interactive
```

Configuration is stored at `~/.praefex/pica/config.json`. You can also set the
API key via the `XAI_API_KEY` environment variable.

| Provider  | Config key       | Default model      |
| --------- | ---------------- | ------------------ |
| xAI/Grok  | `xai_key`        | grok-3-latest      |
| OpenAI    | `openai_key`     | gpt-4o             |

## Requirements

- Python 3.10+
- macOS, Linux, or Windows
- An API key for at least one supported LLM provider

## Feedback

Praefex Nexus is in active development. Tell us what works, what doesn't, and
what you wish it did:

- Web: [praefex.com/feedback](https://praefex.com/feedback)
- CLI: `pica feedback` (opens the form in your browser)

The web UI also has a small "Report issue or suggest feature" link in the
footer.

## License

MIT — see [LICENSE](LICENSE).

---

Praefex Nexus is part of [praefex.com](https://praefex.com).
