Metadata-Version: 2.4
Name: kabi-tg-cli
Version: 0.4.1
Summary: Telethon-powered Telegram CLI for local sync, search, and agent-friendly retrieval
Project-URL: Homepage, https://github.com/jackwener/tg-cli
Project-URL: Repository, https://github.com/jackwener/tg-cli
Project-URL: Issues, https://github.com/jackwener/tg-cli/issues
Author-email: jackwener <jakevingoo@gmail.com>
License: 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
License-File: LICENSE
Keywords: agent,cli,search,telegram,telethon,tg
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Communications :: Chat
Classifier: Topic :: Utilities
Requires-Python: >=3.10
Requires-Dist: click>=8.0
Requires-Dist: python-dotenv>=1.0
Requires-Dist: pyyaml>=6.0
Requires-Dist: rich>=13.0
Requires-Dist: telethon>=1.36
Provides-Extra: dev
Requires-Dist: pytest-asyncio>=0.24; extra == 'dev'
Requires-Dist: pytest>=8.0; extra == 'dev'
Requires-Dist: ruff>=0.11; extra == 'dev'
Requires-Dist: twine>=6.1; extra == 'dev'
Description-Content-Type: text/markdown

# tg-cli

[![CI](https://github.com/jackwener/tg-cli/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/jackwener/tg-cli/actions/workflows/ci.yml)
[![PyPI](https://img.shields.io/pypi/v/kabi-tg-cli)](https://pypi.org/project/kabi-tg-cli/)
[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](LICENSE)

Telethon-powered Telegram CLI for local-first sync, search, export, and agent-friendly retrieval.

It uses your own Telegram account over MTProto, not the Bot API. Messages are synced into local SQLite,
so humans and AI agents can query the same cache quickly with `--json` or `--yaml`.

## Features

- Sync Telegram dialogs into a local SQLite cache
- Search by keyword or regex, with chat, sender, and time filters
- Browse recent messages, today's messages, top senders, and timelines
- Export messages as text, JSON, or YAML
- Keep a near-real-time cache with `tg listen --persist`
- Prefer YAML for AI agents when a strict JSON parser is not required

## Installation

```bash
# Install from PyPI
uv tool install kabi-tg-cli

# Or: pipx / pip
pipx install kabi-tg-cli
pip install kabi-tg-cli
```

Install from GitHub:

```bash
uv tool install git+https://github.com/jackwener/tg-cli.git
```

Install from source:

```bash
git clone git@github.com:jackwener/tg-cli.git
cd tg-cli
uv sync --extra dev
```

## Quick Start

```bash

# Configure credentials first
export TG_API_ID=123456
export TG_API_HASH=your_telegram_app_hash
# Or create a .env file with the same variables

# Login (first run) — enter phone + verification code
tg chats

# Check who you are
tg whoami

# Refresh local cache from all current dialogs
tg refresh

# See today's messages
tg today

# Search
tg search "Rust"
tg search "Rust" --sender "Alice" --hours 48
tg search "Rust|Golang" --regex --hours 72
tg recent --hours 24 --limit 20 --yaml
tg search "Rust" --sync-first --yaml

# Filter by keywords (comma-separated, OR logic)
tg filter "Rust,Golang,Java" --hours 48 --sync-first

# Keep a near-real-time local cache
tg listen --persist

# Send a message
tg send "GroupName" "Hello!"
```

## Why This Exists

`tg-cli` is intentionally local-first:

- `tg refresh`, `tg sync`, `tg sync-all`, and `tg listen` ingest data from Telegram
- `today`, `recent`, `search`, `filter`, `stats`, `top`, and `timeline` read from local SQLite

That makes repeated analysis fast, scriptable, and suitable for AI agents. If you need fresh data right
before a query, use `--sync-first`.

## Commands

### Telegram (`tg ...`)

| Command | Description |
|---------|-------------|
| `tg chats [--type group] [--json\|--yaml]` | List joined chats |
| `tg whoami [--json\|--yaml]` | Show current user info |
| `tg history CHAT -n 1000` | Fetch historical messages |
| `tg sync CHAT` | Incremental sync (only new messages) |
| `tg sync-all [--json\|--yaml]` | Low-level sync for all current dialogs |
| `tg refresh [--json\|--yaml]` | Recommended daily refresh entrypoint |
| `tg listen [CHATS...] [--persist]` | Real-time listener with optional auto-reconnect |
| `tg info CHAT [--json\|--yaml]` | Show detailed chat info |
| `tg send CHAT "msg"` | Send a message |

### Query

| Command | Description |
|---------|-------------|
| `search KEYWORD [-c NAME] [-s SENDER] [--hours N] [--regex] [--sync-first] [--json\|--yaml]` | Search stored messages with chat/sender/time filters or regex |
| `recent [-c NAME] [-s SENDER] [--hours N] [-n LIMIT] [--sync-first] [--json\|--yaml]` | Browse recent messages without a keyword |
| `filter KEYWORDS [-c NAME] [--hours N] [--sync-first] [--json\|--yaml]` | Multi-keyword filter (OR logic, highlighted) |
| `stats [--sync-first] [--json\|--yaml]` | Show message statistics |
| `top [-c NAME] [--hours 24] [--sync-first] [--json\|--yaml]` | Most active senders |
| `timeline [-c NAME] [--by day\|hour] [--sync-first] [--json\|--yaml]` | Message activity bar chart |
| `today [-c NAME] [--sync-first] [--json\|--yaml]` | Show today's messages by chat |


| Command | Description |
|---------|-------------|
| `export CHAT [-f text\|json\|yaml] [-o FILE] [--hours N]` | Export messages |
| `purge CHAT [-y]` | Delete stored messages |

### Global Options

| Option | Description |
|--------|-------------|
| `-v, --verbose` | Enable debug logging |
| `--version` | Show version |

## Setup

```bash
uv tool install kabi-tg-cli  # or: pip install kabi-tg-cli
# Set TG_API_ID and TG_API_HASH in your shell or a .env file
tg chats
```

After that, tg-cli stores your session locally and reuses it.

**Required:**
- Set `TG_API_ID` and `TG_API_HASH` in your environment or `.env`

**Optional:**
- Custom data dir: `DATA_DIR=./data` or `DB_PATH=./data/messages.db`
- Custom session file name: `TG_SESSION_NAME=my_session`

Apply for your own Telegram app credentials at [my.telegram.org/apps](https://my.telegram.org/apps).

## Refresh Modes

`tg-cli` is local-first: `search`, `recent`, `today`, `filter`, `stats`, `top`, and `timeline`
read from the local SQLite cache, not directly from Telegram.

- `tg refresh` is the recommended daily command. It refreshes all current dialogs and prints a short summary.
- `tg sync-all` is the lower-level primitive if you want explicit control in scripts.
- `--sync-first` is available on query commands when you want fresh data before reading.
- `tg listen --persist` keeps reconnecting automatically and is the closest thing to a live cache.

Examples:

```bash
tg refresh
tg today --sync-first --yaml
tg top --hours 24 --sync-first
tg listen --persist --retry-seconds 5
```

## Automation Examples

If you do not want to run `tg refresh` manually, use a scheduler.

### cron

See [examples/tg-refresh.cron](https://github.com/jackwener/tg-cli/blob/main/examples/tg-refresh.cron).

### systemd user timer

See:
- [tg-refresh.service](https://github.com/jackwener/tg-cli/blob/main/examples/systemd/tg-refresh.service)
- [tg-refresh.timer](https://github.com/jackwener/tg-cli/blob/main/examples/systemd/tg-refresh.timer)

Typical flow:

```bash
mkdir -p ~/.config/systemd/user
cp examples/systemd/tg-refresh.service ~/.config/systemd/user/
cp examples/systemd/tg-refresh.timer ~/.config/systemd/user/
systemctl --user daemon-reload
systemctl --user enable --now tg-refresh.timer
```

## Manual Smoke Test

With valid `TG_API_ID`, `TG_API_HASH`, and a working local session:

```bash
tg whoami
tg refresh --yaml
tg recent --hours 24 --limit 5 --yaml
tg search "test" --hours 24 --sync-first --yaml
tg today --sync-first
```

These commands cover auth, sync, local reads, and structured output without sending messages.

## Troubleshooting

- `Missing TG_API_ID / TG_API_HASH`
  - Apply for your own app credentials at [my.telegram.org/apps](https://my.telegram.org/apps).
- `No messages today`
  - Run `tg refresh` first, or use `tg today --sync-first`.
- `Chat '...' not found in database`
  - Run `tg refresh` first, or use the numeric `chat_id` from `tg chats --yaml`.
- Repeatedly running `sync-all`
  - Prefer `tg refresh` for daily use, `--sync-first` for single queries, or `tg listen --persist` for a near-live cache.

## Architecture

```
src/tg_cli/
├── cli/
│   ├── main.py      # Click CLI entry point + verbose
│   ├── tg.py        # Telegram: chats, sync, refresh, listen, whoami, send
│   ├── query.py     # Query: search, regex, recent, filter, stats, today, top, timeline
├── client.py        # Telethon client (connection reuse)
├── config.py        # Config and required user-provided credentials
├── db.py            # SQLite message store
```

## Use as AI Agent Skill

tg-cli ships with a [`SKILL.md`](./SKILL.md) for AI agent integration.

For AI agents, prefer `--yaml` when a downstream parser does not strictly require JSON.
YAML is usually shorter than pretty-printed JSON and saves tokens while remaining structured.

Recommended agent pattern:

```bash
tg refresh --yaml
tg recent --hours 24 --sync-first --yaml
tg filter "招聘,remote" --hours 24 --sync-first --yaml
```

The recommended agent workflow is:

1. `tg refresh --yaml`
2. `tg chats --yaml`
3. `tg recent --hours 24 --sync-first --yaml`
4. `tg search "keyword" --chat "GroupName" --sync-first --yaml`

### Claude Code / Antigravity

```bash
mkdir -p .agents/skills
git clone git@github.com:jackwener/tg-cli.git .agents/skills/tg-cli
```

### OpenClaw / ClawHub

```bash
clawhub install tg-cli
```

## License

Apache-2.0
