ark-utils-cli 0.3.0__tar.gz

ark_utils_cli-0.3.0/.github/workflows/pypi-publish.yml

@@ -0,0 +1,32 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v4
+        with:
+          version: "latest"
+
+      - name: Set up Python
+        run: uv python install 3.11
+
+      - name: Install dependencies
+        run: uv sync
+
+      - name: Build package
+        run: uv build
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

ark_utils_cli-0.3.0/.github/workflows/release.yml

@@ -0,0 +1,46 @@
+name: Build and Release
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+permissions:
+  contents: write
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v4
+        with:
+          version: "latest"
+
+      - name: Set up Python
+        run: uv python install 3.11
+
+      - name: Install dependencies
+        run: uv sync
+
+      - name: Build package
+        run: uv build
+
+      - name: Upload to TOS
+        env:
+          TOS_ACCESS_KEY: ${{ secrets.TOS_ACCESS_KEY }}
+          TOS_SECRET_KEY: ${{ secrets.TOS_SECRET_KEY }}
+        run: |
+          VERSION=$(uv run python -c "from ark_cli import __version__; print(__version__)")
+          uv run ark-cli -p tos -a upload -bucket xmp -i dist/ark_utils_cli-${VERSION}-py3-none-any.whl -o ark-cli/ark_utils_cli-${VERSION}-py3-none-any.whl
+
+      - name: Create GitHub Release
+        uses: softprops/action-gh-release@v2
+        with:
+          files: |
+            dist/*.whl
+            dist/*.tar.gz
+          generate_release_notes: true

ark_utils_cli-0.3.0/.gitignore

@@ -0,0 +1,207 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+#poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+#pdm.lock
+#pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+#pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#  you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/

ark_utils_cli-0.3.0/.python-version

@@ -0,0 +1 @@
+3.11

ark_utils_cli-0.3.0/CLAUDE.md

@@ -0,0 +1,45 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## 项目概述
+
+ark-cli 是火山引擎命令行工具，让人类和 AI Agent 都能在终端中操作火山引擎。
+
+## 技术栈
+
+- 语言: Python
+- 包管理: uv
+- 许可证: MIT
+
+## 开发命令
+
+```bash
+# 初始化项目
+uv init
+
+# 安装依赖
+uv sync
+
+# 添加依赖
+uv add <package>
+
+# 添加开发依赖
+uv add --dev <package>
+
+# 运行脚本
+uv run python <script.py>
+
+# 运行测试
+uv run pytest
+
+# 代码检查
+uv run ruff check .
+
+# 代码格式化
+uv run ruff format .
+```
+
+## 项目结构
+
+待项目初始化后补充

ark_utils_cli-0.3.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 cnwarden
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

ark_utils_cli-0.3.0/Makefile

@@ -0,0 +1,18 @@
+.PHONY: build publish clean
+
+VERSION := $(shell uv run python -c "from ark_cli import __version__; print(__version__)")
+WHEEL := dist/ark_cli-$(VERSION)-py3-none-any.whl
+BUCKET := xmp
+
+build:
+	uv build
+
+publish: build
+	@if [ ! -f "$(WHEEL)" ]; then \
+		echo "Error: $(WHEEL) not found"; \
+		exit 1; \
+	fi
+	uv run ark-cli -p tos -a upload -bucket $(BUCKET) -i $(WHEEL) -o ark-cli/ark_cli-$(VERSION)-py3-none-any.whl
+
+clean:
+	rm -rf dist/

ark_utils_cli-0.3.0/PKG-INFO

@@ -0,0 +1,277 @@
+Metadata-Version: 2.4
+Name: ark-utils-cli
+Version: 0.3.0
+Summary: 火山引擎命令行工具 - 让人类和 AI Agent 都能在终端中操作火山引擎
+License-File: LICENSE
+Requires-Python: >=3.9
+Requires-Dist: tos>=2.9.0
+Description-Content-Type: text/markdown
+
+<p align="center">
+  <h1 align="center">ark-cli</h1>
+</p>
+
+<p align="center">
+  火山引擎命令行工具 — 让人类和 AI Agent 都能在终端中操作火山引擎
+</p>
+
+<p align="center">
+  <a href="https://github.com/cnwarden/ark-cli/releases"><img src="https://img.shields.io/github/v/release/cnwarden/ark-cli?style=for-the-badge&color=FF6A00" alt="Release" /></a>
+  <a href="https://www.python.org/"><img src="https://img.shields.io/badge/Python-3.9+-3776AB?style=for-the-badge&logo=python&logoColor=white" alt="Python" /></a>
+  <a href="https://github.com/cnwarden/ark-cli/stargazers"><img src="https://img.shields.io/github/stars/cnwarden/ark-cli?style=for-the-badge&color=f5a623" alt="Stars" /></a>
+  <a href="https://github.com/cnwarden/ark-cli/blob/main/LICENSE"><img src="https://img.shields.io/badge/License-MIT-teal.svg?style=for-the-badge" alt="License" /></a>
+</p>
+
+<p align="center">
+  <a href="#ark-cli-是什么">介绍</a> · <a href="#核心能力">核心能力</a> · <a href="#快速开始">快速开始</a> · <a href="#命令参考">命令参考</a> · <a href="#贡献">贡献</a>
+</p>
+
+---
+
+## ark-cli 是什么
+
+ark-cli 是火山引擎的命令行工具，将 TOS 对象存储、大模型服务、联网搜索等操作封装为简洁的命令行接口。
+
+### 为什么选择 ark-cli
+
+- **开箱即用** — 默认配置北京区域，最少只需 2 个环境变量即可开始使用
+- **AI Agent 友好** — 命令设计简洁，输出格式规范，便于 AI Agent 解析调用
+- **临时链接** — 上传文件自动返回 24 小时有效的签名 URL
+- **轻量依赖** — 基于 Python，使用 uv 包管理，安装简单
+
+## 核心能力
+
+| 模块 | 能力 |
+|------|------|
+| **TOS 对象存储** | 文件上传、列表、删除、临时链接生成、Bucket 统计 |
+| **大模型服务** | 单轮对话、Token 用量统计、耗时统计 |
+| **联网搜索** | 网页搜索、结果摘要、时间范围过滤 |
+
+## 快速开始
+
+### 安装
+
+**从源码安装**
+
+```bash
+git clone https://github.com/cnwarden/ark-cli.git
+cd ark-cli
+uv sync
+```
+
+**从 Release 下载**
+
+从 [Releases](https://github.com/cnwarden/ark-cli/releases/latest) 页面下载最新的 wheel 包：
+
+```bash
+pip install ark_cli-*.whl
+```
+
+### 配置凭证
+
+```bash
+# TOS 对象存储（必需）
+export TOS_ACCESS_KEY="your-access-key"
+export TOS_SECRET_KEY="your-secret-key"
+
+# TOS 可选配置（默认北京区域）
+export TOS_ENDPOINT="tos-cn-beijing.volces.com"
+export TOS_REGION="cn-beijing"
+
+# 大模型服务（使用 model 功能时必需）
+export ARK_API_KEY="your-api-key"
+
+# 联网搜索（使用 search 功能时必需）
+export SEARCH_API_KEY="your-search-api-key"
+```
+
+### 验证安装
+
+```bash
+ark-cli -v
+```
+
+## 命令参考
+
+```
+ark-cli [-p PRODUCT] [-a ACTION] [OPTIONS]
+
+Products:
+  tos       TOS 对象存储操作
+  model     大模型对话
+  search    联网搜索
+
+TOS Actions:
+  upload    上传文件
+  ls        列出文件
+  lsb       列出 Bucket
+  geturl    获取临时链接
+  rm        删除文件
+  stats     Bucket 统计信息
+
+Model Options:
+  -m        模型名称（例如: doubao-seed-2-0-mini-260215）
+  -c        对话内容
+
+Search Options:
+  -q        搜索关键词
+  --count   返回条数（默认: 10, 最多: 50）
+```
+
+<details>
+<summary>TOS 对象存储</summary>
+
+```bash
+# 上传文件（返回 24 小时有效的签名链接）
+ark-cli -p tos -a upload -bucket my-bucket -i ./test.txt -o data/test.txt
+
+# 列出 Bucket
+ark-cli -p tos -a lsb
+
+# 列出文件
+ark-cli -p tos -a ls -bucket my-bucket
+ark-cli -p tos -a ls -bucket my-bucket -i data/
+
+# 获取临时链接
+ark-cli -p tos -a geturl -bucket my-bucket -i data/test.txt
+
+# 删除文件
+ark-cli -p tos -a rm -bucket my-bucket -i data/test.txt
+
+# Bucket 统计信息
+ark-cli -p tos -a stats -bucket my-bucket
+```
+
+**输出示例**
+
+列出文件：
+```
+DIR        -                    data/subdir/
+1.2KB      2024-03-30 10:00:00  data/test.txt
+256B       2024-03-30 09:30:00  data/config.json
+```
+
+Bucket 统计：
+```
+Bucket:      my-bucket
+Location:    cn-beijing
+Created:     2025-05-12 12:29:06
+Storage:     Storage_Class_Standard
+Redundancy:  Az_Redundancy_Single_Az
+Versioning:  Versioning_Unknown
+Endpoint:    tos-cn-beijing.volces.com
+```
+
+</details>
+
+<details>
+<summary>大模型对话</summary>
+
+```bash
+# 单轮对话
+ark-cli -p model -m doubao-seed-2-0-mini-260215 -c "你好，请介绍一下你自己"
+```
+
+**输出示例**
+```
+嗨！👋 你好呀~ 请问有什么我可以帮你的吗？
+
+[耗时: 5991ms | tokens: 50 in / 371 out]
+```
+
+</details>
+
+<details>
+<summary>联网搜索</summary>
+
+```bash
+# 基础搜索
+ark-cli -p search -q "火山引擎"
+
+# 指定返回条数
+ark-cli -p search -q "Python 教程" --count 5
+```
+
+**输出示例**
+```
+[1] 火山引擎官网 - 字节跳动旗下云服务平台
+    火山引擎 | 2025-03-30
+    https://www.volcengine.com/
+    火山引擎是字节跳动旗下的云服务平台，提供云计算、大数据、人工智能等服务...
+
+[2] 火山引擎开放平台 - 开发者文档
+    火山引擎 | 2025-03-28
+    https://www.volcengine.com/docs
+    火山引擎开放平台提供丰富的 API 和 SDK，帮助开发者快速接入...
+
+[共 10 条结果 | 耗时: 372ms]
+```
+
+</details>
+
+## 技术栈
+
+| 组件 | 选型 | 说明 |
+|------|------|------|
+| 语言 | [Python](https://www.python.org/) 3.9+ | |
+| 包管理 | [uv](https://github.com/astral-sh/uv) | 快速的 Python 包管理器 |
+| TOS SDK | [tos](https://github.com/volcengine/ve-tos-python-sdk) | 火山引擎 TOS 官方 SDK |
+| 构建工具 | [hatchling](https://hatch.pypa.io/) | Python 构建后端 |
+
+## 项目结构
+
+```
+ark-cli/
+├── ark_cli/
+│   ├── __init__.py          # 版本定义
+│   ├── cli.py                # CLI 入口
+│   ├── tos_client.py         # TOS 客户端封装
+│   ├── model_client.py       # 大模型客户端
+│   └── search_client.py      # 联网搜索客户端
+├── pyproject.toml            # 项目配置
+├── Makefile                  # 构建脚本
+└── README.md
+```
+
+## 开发
+
+```bash
+# 克隆项目
+git clone https://github.com/cnwarden/ark-cli.git
+cd ark-cli
+
+# 安装依赖
+uv sync
+
+# 运行
+uv run ark-cli -v
+
+# 构建
+uv build
+
+# 发布到 TOS
+make publish
+```
+
+## 贡献
+
+欢迎提交 Issue 和 Pull Request！
+
+1. Fork 本仓库
+2. 创建特性分支：`git checkout -b feature/amazing-feature`
+3. 提交更改：`git commit -m 'feat: add amazing feature'`
+4. 推送分支：`git push origin feature/amazing-feature`
+5. 提交 Pull Request
+
+提交信息请遵循 [Conventional Commits](https://www.conventionalcommits.org/) 规范。
+
+## License
+
+[MIT](LICENSE)
+
+## 相关链接
+
+- [火山引擎控制台](https://console.volcengine.com/) — 获取 Access Key
+- [TOS 文档](https://www.volcengine.com/docs/6349) — 对象存储文档
+- [方舟大模型](https://www.volcengine.com/docs/82379) — 大模型服务文档
+- [联网搜索 API](https://www.volcengine.com/docs/87772/2272953) — 联网搜索文档