Metadata-Version: 2.4
Name: openrssgate
Version: 0.1.3
Summary: Read-only CLI for querying OpenRSSGate sources and feeds.
Author: OpenRSSGate
License-Expression: MIT
Project-URL: Homepage, https://github.com/windbug99/openrssgate
Project-URL: Repository, https://github.com/windbug99/openrssgate
Project-URL: Issues, https://github.com/windbug99/openrssgate/issues
Keywords: rss,cli,feeds,mcp,openrssgate
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content :: News/Diary
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.11
Description-Content-Type: text/markdown
Requires-Dist: httpx==0.28.1
Requires-Dist: typer==0.16.1

# OpenRSSGate CLI

## Install

권장 설치 방식은 `pipx` 또는 Homebrew입니다.

Local install with `pipx`:

```bash
cd /Users/tomato/cursor/openrssgate/cli
pipx install .
```

After PyPI release:

```bash
pipx install openrssgate
org list
```

If `~/.local/bin` is not on your shell `PATH` yet:

```bash
pipx ensurepath
source ~/.zshrc
org list
```

Install directly from GitHub before the PyPI release:

```bash
pipx install "git+https://github.com/<owner>/openrssgate.git#subdirectory=cli"
```

Release steps are documented in [RELEASE.md](/Users/tomato/cursor/openrssgate/cli/RELEASE.md).
Homebrew tap packaging notes are documented in [homebrew/README.md](/Users/tomato/cursor/openrssgate/cli/homebrew/README.md).
External service setup steps are documented in [EXTERNAL_SETUP.md](/Users/tomato/cursor/openrssgate/cli/EXTERNAL_SETUP.md).

After Homebrew tap release:

```bash
brew tap windbug99/homebrew-tap
brew install openrssgate
org list
```

Verified release:

- PyPI: `openrssgate==0.1.2`
- Homebrew tap: `windbug99/homebrew-tap`

## Run

The CLI uses the deployed OpenRSSGate API by default. Set `OPENRSSGATE_API_BASE_URL` only if you want to target a custom server.

```bash
org list
org feeds --q openai --tag ai --since 7d
org stats
org validate https://example.com/rss.xml
org feed <feed_id>
```

Typical lookup flow:

```bash
org list --keyword platformer
org feeds <source_id>
org feed <feed_id>
```

Common mistakes:

- `org feeds <source_id>` lists feeds that belong to one source.
- `org feed <feed_id>` shows one specific feed item.
- `org validate <rss_url>` expects a direct RSS or Atom feed URL, not a website homepage.

To target a local or self-hosted backend:

```bash
export OPENRSSGATE_API_BASE_URL=http://127.0.0.1:8000/v1
org list
```

Compatibility note:

- `org` is the preferred command name.
- `openrssgate` remains available as a backward-compatible alias.
