xhs-cli-headless 0.8.4__tar.gz

xhs_cli_headless-0.8.4/.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,49 @@
+name: Bug Report
+description: Report a bug or unexpected behavior
+labels: ["bug"]
+body:
+  - type: input
+    id: version
+    attributes:
+      label: Version
+      description: "Run `xhs --version`"
+      placeholder: "e.g. 1.0.0"
+    validations:
+      required: true
+  - type: dropdown
+    id: os
+    attributes:
+      label: Operating System
+      options:
+        - macOS
+        - Linux
+        - Windows
+        - Other
+    validations:
+      required: true
+  - type: textarea
+    id: description
+    attributes:
+      label: What happened?
+      description: Describe the bug clearly.
+    validations:
+      required: true
+  - type: textarea
+    id: expected
+    attributes:
+      label: Expected behavior
+      description: What did you expect to happen?
+    validations:
+      required: true
+  - type: textarea
+    id: reproduce
+    attributes:
+      label: Steps to reproduce
+      description: "Commands or steps to reproduce the issue. Use `xhs -v <command>` for debug output."
+      render: bash
+  - type: textarea
+    id: logs
+    attributes:
+      label: Error output / logs
+      description: Paste any error messages or verbose output here.
+      render: text

xhs_cli_headless-0.8.4/.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,24 @@
+name: Feature Request
+description: Suggest a new feature or improvement
+labels: ["enhancement"]
+body:
+  - type: input
+    id: version
+    attributes:
+      label: Current version
+      description: "Run `xhs --version`"
+      placeholder: "e.g. 1.0.0"
+    validations:
+      required: false
+  - type: textarea
+    id: description
+    attributes:
+      label: Describe the feature
+      description: What would you like to see added or changed?
+    validations:
+      required: true
+  - type: textarea
+    id: use_case
+    attributes:
+      label: Use case
+      description: Why do you need this feature? How would you use it?

xhs_cli_headless-0.8.4/.github/workflows/ci.yml

@@ -0,0 +1,57 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+  workflow_call:
+
+jobs:
+  lint-and-test:
+    name: Lint and test (Python ${{ matrix.python-version }})
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.10", "3.12", "3.13"]
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+
+      - name: Install dependencies
+        run: uv sync --extra dev
+
+      - name: Run ruff
+        run: uv run ruff check .
+
+      - name: Run tests
+        run: uv run python -m pytest -q --ignore=tests/test_integration.py
+
+  build:
+    name: Build package
+    runs-on: ubuntu-latest
+    needs: lint-and-test
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+
+      - name: Install dependencies
+        run: uv sync --extra dev
+
+      - name: Build distribution
+        run: uv build

xhs_cli_headless-0.8.4/.github/workflows/publish.yml

@@ -0,0 +1,66 @@
+name: Build And Publish
+
+on:
+  push:
+    tags:
+      - "v*"
+  workflow_dispatch:
+
+jobs:
+  verify:
+    uses: ./.github/workflows/ci.yml
+
+  release-assets:
+    needs: verify
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Setup uv
+        uses: astral-sh/setup-uv@v6
+
+      - name: Build package
+        run: uv build
+
+      - name: Upload dist artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist-${{ github.ref_name }}
+          path: dist/*
+
+      - name: Attach artifacts to GitHub release
+        uses: softprops/action-gh-release@v2
+        with:
+          name: ${{ github.ref_name }}
+          body_path: RELEASE_NOTES.md
+          files: dist/*
+
+  publish-pypi:
+    needs: verify
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Setup uv
+        uses: astral-sh/setup-uv@v6
+
+      - name: Build package
+        run: uv build
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

xhs_cli_headless-0.8.4/.gitignore

@@ -0,0 +1,12 @@
+__pycache__/
+*.pyc
+.venv/
+dist/
+*.egg-info/
+.ruff_cache/
+.mypy_cache/
+.pytest_cache/
+.playwright-mcp/
+xhs_login_page.png
+project_design.md
+xhs_cli/test/

xhs_cli_headless-0.8.4/LICENSE

@@ -0,0 +1,201 @@
+                                 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
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

xhs_cli_headless-0.8.4/NOTICE

@@ -0,0 +1,23 @@
+This repository is a maintained fork of:
+
+  jackwener/xiaohongshu-cli
+  https://github.com/jackwener/xiaohongshu-cli
+
+Current repository:
+
+  kyalpha313/xhs-cli-headless
+  https://github.com/kyalpha313/xhs-cli-headless
+
+This fork keeps the upstream reverse-engineered Xiaohongshu CLI foundation
+and introduces substantial changes for headless and agent-oriented usage,
+including but not limited to:
+
+- headless-first QR login as the default recommended login flow
+- auth diagnostics and session inspection commands
+- session import workflow for existing cookies
+- structured CLI output improvements
+- release-surface reduction to stable default commands only
+- documentation and release materials aligned to the stable command surface
+
+This NOTICE file is provided for attribution and project-history clarity.
+See LICENSE for the full Apache License 2.0 terms.

xhs_cli_headless-0.8.4/PKG-INFO

@@ -0,0 +1,239 @@
+Metadata-Version: 2.4
+Name: xhs-cli-headless
+Version: 0.8.4
+Summary: Headless-friendly Xiaohongshu CLI fork focused on QR login and automation
+Project-URL: Homepage, https://github.com/kyalpha313/xhs-cli-headless
+Project-URL: Repository, https://github.com/kyalpha313/xhs-cli-headless
+Project-URL: Issues, https://github.com/kyalpha313/xhs-cli-headless/issues
+Author-email: jackwener <jakevingoo@gmail.com>
+Maintainer-email: kyalpha313 <kyalpha313@users.noreply.github.com>
+License-Expression: Apache-2.0
+License-File: LICENSE
+License-File: NOTICE
+Keywords: agent,api,cli,headless,redbook,xhs,xiaohongshu
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Utilities
+Requires-Python: >=3.10
+Requires-Dist: browser-cookie3>=0.19
+Requires-Dist: camoufox>=0.4.11
+Requires-Dist: click>=8.0
+Requires-Dist: httpx>=0.27
+Requires-Dist: pycryptodome>=3.20
+Requires-Dist: pyyaml>=6.0
+Requires-Dist: qrcode>=7.0
+Requires-Dist: rich>=13.0
+Requires-Dist: xhshow>=0.1.9
+Provides-Extra: dev
+Requires-Dist: mypy>=1.15.0; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.23; extra == 'dev'
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Requires-Dist: ruff>=0.11.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# xhs-cli-headless
+
+一个面向无 GUI / 远程服务器 / Agent 场景的小红书 CLI fork。
+
+- Fork 仓库：[kyalpha313/xhs-cli-headless](https://github.com/kyalpha313/xhs-cli-headless)
+- 上游项目：[jackwener/xiaohongshu-cli](https://github.com/jackwener/xiaohongshu-cli)
+- CLI 命令：`xhs`
+
+> 说明：这是基于上游项目维护的发布分支，重点强化了 headless 二维码登录、登录态诊断、结构化输出和发布前验证流程。README 已按本 fork 的真实支持范围重写，不再沿用上游的推广内容与发布口径。
+
+## 中文说明
+
+### 项目定位
+
+`xhs-cli-headless` 是一个以“服务器可用、Agent 可用、少人工介入”为目标的小红书 CLI fork。
+
+### 与上游的关系
+
+- 本仓库是 [jackwener/xiaohongshu-cli](https://github.com/jackwener/xiaohongshu-cli) 的 fork。
+- 本 fork 的 README、测试矩阵和发布说明，只描述当前 fork 已验证的行为，不默认继承上游全部能力承诺。
+- 原项目需要浏览器实现登陆动作，不适合服务器部署与Agent交互，本项目完善了命令行模式下的登陆功能，包括纯 HTTP 二维码登录，登录态导入 / 诊断 / 检查等。
+
+### 首版稳定范围
+
+以下能力已收敛为本 fork 当前首版稳定范围：
+
+- `xhs login` 默认 headless 二维码登录（即--qrcode-http，含终端二维码 + 登录链接）
+- `xhs status` 检查登录态
+- `xhs whoami` 获取当前用户 ID
+- `xhs auth doctor` 诊断当前登录态是否完整、是否可用
+- `xhs auth inspect` 检查本地已保存 cookies 的字段情况（不输出敏感值）
+- `xhs auth import --file` 导入 cookies
+- `xhs search` 搜索笔记
+- `xhs search-user` 搜索用户
+- `xhs topics` 获取话题
+- `xhs feed` 获取动态
+- `xhs hot` 获取热门笔记
+- `xhs read` 读取笔记
+- `xhs comments` 获取评论
+- `xhs my-notes` 获取自己的笔记
+- `xhs unread` 获取未读笔记
+- `xhs like` / `xhs like --undo` 点赞/取消点赞笔记
+- `xhs favorite` / `xhs unfavorite` 收藏/取消收藏笔记
+- `xhs comment` / `xhs delete-comment` 评论/删除评论
+- `xhs follow` / `xhs unfollow` 关注/取消关注用户
+
+### 当前未纳入发布命令面
+
+以下能力当前不纳入本 release 的默认命令面：
+
+- `xhs login --browser` 浏览器方式登录
+- `xhs login --qrcode` 浏览器辅助二维码登录
+- `xhs sub-comments` 获取子评论
+- `xhs reply` 回复评论
+- `xhs post` 发布笔记
+- `xhs delete` 删除笔记
+- `xhs user` 获取用户信息
+- `xhs user-posts` 获取用户笔记
+- `xhs favorites` 获取收藏笔记
+- `xhs likes` 获取点赞笔记
+- `xhs notifications` 获取通知
+
+说明：
+
+- 上述能力中，一部分是兼容/实验路径，另一部分已确认在当前 public web API 下不可稳定使用
+- 它们当前不在 `xhs --help` 的默认命令列表中，也不应作为 Agent 的默认调用入口
+
+### 安装
+
+#### 方式 1：直接从本 fork 安装
+
+```bash
+uv tool install git+https://github.com/kyalpha313/xhs-cli-headless
+```
+
+或：
+
+```bash
+pipx install git+https://github.com/kyalpha313/xhs-cli-headless
+```
+
+PyPI 发布后，也可以改为：
+
+```bash
+uv tool install xhs-cli-headless
+pipx install xhs-cli-headless
+```
+
+计划使用的 PyPI 包名为 `xhs-cli-headless`。
+
+#### 方式 2：源码运行
+
+```bash
+git clone https://github.com/kyalpha313/xhs-cli-headless.git
+cd xhs-cli-headless
+uv sync
+```
+
+### 快速开始
+
+```bash
+# 1) 推荐：直接登录（默认就是 headless 二维码 + 终端二维码 + 登录链接）
+xhs login
+
+# 2) 检查登录态
+xhs status --yaml
+xhs auth doctor --yaml
+xhs auth inspect --yaml
+
+# 3) 核心只读命令
+xhs search "小红书" --yaml
+xhs read <note_id_or_url> --yaml
+xhs comments <note_id_or_url> --yaml
+```
+
+### 认证方式
+
+当前对外推荐的认证方式：
+
+- 默认推荐：`xhs login`
+  - 默认 headless 二维码登录，包含终端二维码和登录链接
+- 显式指定纯 HTTP 二维码：`xhs login --qrcode-http`
+  - 与默认 `xhs login` 属于同一路径
+- 导入已有登录态：`xhs auth import --file cookies.json`
+  - 适合从其他环境迁移已验证 cookies
+- 从浏览器/F12 粘贴关键字段：`xhs auth import-fields --interactive`
+  - 适合在用户本机浏览器完成登录后，把关键 cookies 字段带回服务器
+
+说明：
+
+- `xhs status`、`xhs whoami`、`xhs read` 等命令默认只使用本地已保存登录态
+- 若当前没有有效登录态，请先执行 `xhs login` 或 `xhs auth import --file cookies.json`
+- 如果 `xhs login` 在扫码确认后触发额外验证码，请参考 [browser-cookie-recovery.md](file:///Users/bytedance/Documents/Trae/xhs-cli-headless/docs/browser-cookie-recovery.md)
+
+辅助命令：
+
+```bash
+xhs auth doctor
+xhs auth inspect
+xhs auth import --file cookies.json
+```
+
+### 常用命令
+
+```bash
+# Auth
+xhs login
+xhs login --qrcode-http
+xhs status
+xhs whoami
+xhs auth doctor
+xhs auth inspect
+xhs auth import --file cookies.json
+xhs auth import-fields --interactive
+xhs logout
+
+# Search / Reading
+xhs search "美食"
+xhs search-user "用户关键词"
+xhs topics "旅行"
+xhs feed
+xhs hot
+xhs read <note_id_or_url>
+xhs comments <note_id_or_url>
+
+# Interactions
+xhs like <note_id_or_url>
+xhs like <note_id_or_url> --undo
+xhs favorite <note_id_or_url>
+xhs unfavorite <note_id_or_url>
+xhs comment <note_id_or_url> -c "好赞"
+xhs delete-comment <note_id> <comment_id>
+xhs follow <user_id>
+xhs unfollow <user_id>
+```
+
+### 登录恢复
+
+如果 `xhs login` 在扫码确认后仍被平台要求额外验证码：
+
+- 优先在你自己的浏览器里完成验证
+- 然后使用 `xhs auth import-fields --interactive`
+- 详细步骤见 [browser-cookie-recovery.md](file:///Users/bytedance/Documents/Trae/xhs-cli-headless/docs/browser-cookie-recovery.md)
+
+### 结构化输出
+
+所有命令都支持：
+
+- `--yaml`
+- `--json`
+
+非 TTY 输出默认会偏向结构化格式，适合脚本和 Agent 使用。
+
+统一 envelope 见 [SCHEMA.md](./SCHEMA.md)。
+
+```bash
+uv sync
+uv run pytest tests/ -v
+uv run pytest -m smoke tests/test_smoke.py -q
+```
+
+## License
+
+Apache-2.0