Metadata-Version: 2.4
Name: openfish
Version: 1.0.0
Summary: OpenFish: single-user Telegram-driven personal Codex assistant
Author: Re13orn
License-Expression: MIT
Project-URL: Homepage, https://github.com/Re13orn/openfish
Project-URL: Repository, https://github.com/Re13orn/openfish
Project-URL: Issues, https://github.com/Re13orn/openfish/issues
Project-URL: Changelog, https://github.com/Re13orn/openfish/blob/main/CHANGELOG.md
Keywords: telegram,codex,assistant,cli,self-hosted
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Communications :: Chat
Classifier: Topic :: Software Development :: Build Tools
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.12
Description-Content-Type: text/markdown
Requires-Dist: PyYAML>=6.0
Requires-Dist: python-telegram-bot>=22.0
Provides-Extra: dev
Requires-Dist: pytest>=8.0; extra == "dev"

OpenFish
========

OpenFish is a single-user, Telegram-driven local Codex assistant.

It lets one trusted owner control local repositories from Telegram while execution, approvals, state, and audit data remain on the local machine.

Core capabilities
-----------------

- Project lifecycle: list, select, add, disable, archive
- Task lifecycle: ask, do, resume, retry, cancel
- Scheduling: periodic task add/list/run/pause/enable/delete
- Approval flow: approve/reject continuation
- Project memory: notes, recent summaries, paginated memory view
- Codex session browser: OpenFish sessions and local native sessions
- MCP management: list, inspect, enable, disable
- Service controls: restart, logs, update-check, self-update
- CLI runtime: `openfish install`, `configure`, `check`, `start`

Quick start
-----------

Install:

```bash
pip install openfish
```

Repository mode:

```bash
openfish install
openfish configure
openfish check
openfish start
```

Home runtime mode:

```bash
openfish init-home
export OPENFISH_HOME=~/.config/openfish
openfish install
openfish configure
openfish check
openfish start
```

Common commands
---------------

- `openfish install`
- `openfish uninstall`
- `openfish configure`
- `openfish init-home`
- `openfish check`
- `openfish start`
- `openfish stop`
- `openfish restart`
- `openfish status`
- `openfish logs`
- `openfish update-check`

Scope
-----

OpenFish is built for:

- one trusted owner
- local-first execution
- project-scoped continuity
- Telegram as the primary control surface

OpenFish is not:

- a multi-user bot platform
- a public remote shell
- a cloud orchestration system

Links
-----

- Homepage: https://github.com/Re13orn/openfish
- README: https://github.com/Re13orn/openfish/blob/main/README.md
- 中文说明: https://github.com/Re13orn/openfish/blob/main/README_CN.md
- Security: https://github.com/Re13orn/openfish/blob/main/SECURITY.md
- Changelog: https://github.com/Re13orn/openfish/blob/main/CHANGELOG.md
