ChatEnv

ChatArch typed env/profile runtime.

ChatEnv 是 ChatArch / chatxxx 系列项目共用的 typed env/profile 底层包。它提供字段描述、配置基类、registry、路径、profile 文件读写、mask 和 paste 解析等通用能力；同时内置少量跨工具共享 schema（当前为 OpenAI / Feishu）。工具私有变量仍由 ChatTool、ChatDNS 等项目自己定义并注册。

当前设计保持减法：只使用一个根变量 CHATARCH_HOME，只管理 env/profile 文件，不额外创建 config/cache/data/state。

支持 Python >=3.10。

安装

pip install chatenv --upgrade
pip install -e .[dev]       # 仓库开发

目录

CHATARCH_HOME=${CHATARCH_HOME:-~/.chatarch}
$CHATARCH_HOME/envs/

实际布局由业务项目注册的 schema 决定，例如：

~/.chatarch/envs/
  Example/
    .env
    work.env
  • .env 是当前 active profile；
  • name.env 是 named profile；
  • use 会把 named profile 复制为 active .env。

CLI 概览

chatenv CLI 基于已注册 schema 工作。单独安装且没有项目注册 schema 时，它会提示需要先注册配置类型。业务项目通常会在自己的 CLI 中导入 schema 后复用这些能力。

chatenv --version
chatenv --tree
chatenv init -t example
chatenv status
chatenv status --detail
chatenv cat -t example
chatenv cat -t example --no-mask | chatenv paste --stdin --profile work --yes
chatenv set EXAMPLE_API_KEY=sk-xxx
chatenv get EXAMPLE_API_KEY
chatenv new -t example work
chatenv save -t example work
chatenv use -t example work
chatenv delete -t example work

单次命令可通过 --home 覆盖根目录：

chatenv --home /tmp/chatarch cat -t example

缺少必要命令参数时，ChatEnv 默认会在可交互终端中自动补问；显式 -i 始终强制补问，-I 始终禁用补问。自动化环境可设置：

export CHATARCH_AUTO_PROMPT=false

此时只有缺少必要参数的命令会直接报错；参数已经足够的命令行为不变。

chatenv --tree 可从当前安装包的 Click 注册表实时输出完整命令树，用于验收和脚本 readback。

更多用法见 docs/cli.md。

Paste

paste 是跨设备复制密钥的核心入口。输入不要求是严格 dotenv 文件，会从终端日志、shell prompt、复制文本里提取已注册 key；同一行里用空格分隔的多个 KEY='VALUE' 片段也会被逐个识别。

chatenv paste
chatenv paste --stdin --profile work
chatenv paste --value "EXAMPLE_API_KEY='sk-xxx'" --yes
chatenv paste --value "EXAMPLE_MODEL='gpt example' EXAMPLE_API_KEY='sk-xxx'" --yes

写入前会输出识别概要：识别到哪些类型、哪些 key、未知 key 被忽略。

Python API

from chatenv import BaseEnvConfig, EnvField, EnvStore, get_paths

class ExampleConfig(BaseEnvConfig):
    _title = "Example Configuration"
    _aliases = ["example"]
    _storage_dir = "Example"

    EXAMPLE_API_KEY = EnvField("EXAMPLE_API_KEY", is_sensitive=True)

paths = get_paths()
store = EnvStore(paths.envs_dir)
store.save_active(ExampleConfig, {"EXAMPLE_API_KEY": "sk-..."})

文档

  • docs/cli.md：CLI 用法
  • docs/design.md：路径、数据布局与注册策略
  • docs/developer-guide.md：chatxxx 项目接入和 provider 开发指南
  • docs/development.md：测试、构建与发布
  • mkdocs.yml：Material for MkDocs 文档站点配置

开发

python -m pytest -q
python -m build
python -m twine check dist/*
python -m pip install -e .[docs]
python -m mkdocs serve

也可以用 ChatTool helper：

chattool pypi build --project-dir .
chattool pypi check --project-dir .

开源协议

MIT License

Project links

Data verified by PyPI on Aug 11, 2026
Data provided by the project maintainers, verified at the time the release was uploaded to PyPI.

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Newer release available (0.2.11)

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for RexWzh from gravatar.com RexWzh

Credits

Author: rexwzh

GitHub Statistics

Data verified by PyPI on Aug 11, 2026
The GitHub source repository was provided by the project maintainers and verified by PyPI at the time of upload. Stars, forks, and open issues/PRs are derived from that repository and have not been independently verified.

License expression

MIT
View SPDX License List

Requires

Python >=3.10

Provides Extra

dev docs

Tags

chatenv chatarch env

Classifiers

Report project as malware

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

chatenv-0.2.5.tar.gz (29.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

chatenv-0.2.5-py3-none-any.whl (25.5 kB view details)

Uploaded Python 3

File details

Details for the file chatenv-0.2.5.tar.gz.

File metadata

  • Download URL: chatenv-0.2.5.tar.gz
  • Upload date:
  • Size: 29.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for chatenv-0.2.5.tar.gz
Algorithm Hash digest
SHA256 4f2ae36da163181f7148a2f55cb603198b2e9f3275db077561c77fc0b97cdb9b
MD5 5920077cf1300078e30187f85327bd58
BLAKE2b-256 ecefdfa9e06b25e23e5231a6db4eacf48998047c4345e4e6ae4957eb36632349

See more details on using hashes here.

Provenance

The following attestation bundles were made for chatenv-0.2.5.tar.gz:

Publisher: publish.yml on ChatArch/ChatEnv

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file chatenv-0.2.5-py3-none-any.whl.

File metadata

  • Download URL: chatenv-0.2.5-py3-none-any.whl
  • Upload date:
  • Size: 25.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for chatenv-0.2.5-py3-none-any.whl
Algorithm Hash digest
SHA256 e972a97df05f5767a719b6835bcc0c2d20cb9d5b885fc0091ef7478fdaa7608c
MD5 cf23ec843307c421ded53dc358391b20
BLAKE2b-256 234c218c59ada55f86bbad0d92aebf4ba5552c2055a79519c6dc314ec5521ab6

See more details on using hashes here.

Provenance

The following attestation bundles were made for chatenv-0.2.5-py3-none-any.whl:

Publisher: publish.yml on ChatArch/ChatEnv

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

0.2.11

2 files

0.2.10

2 files

0.2.9

2 files

0.2.8

2 files

0.2.7

2 files

0.2.6

2 files

This release

0.2.5 This release

2 files

0.2.4

2 files

0.2.3

2 files

0.2.2

2 files

0.2.1

2 files

0.2.0

2 files

0.1.2

2 files

0.1.1

2 files

0.1.0

2 files

0.0.1

2 files

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page