Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ body:
id: version
attributes:
label: ipcheck version
placeholder: ipcheck 0.3.0
placeholder: ipcheck 0.4.0
validations:
required: true
- type: dropdown
Expand Down
18 changes: 18 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,23 @@
All notable changes to ipcheck are documented here. The project follows
[Semantic Versioning](https://semver.org/).

## [0.4.0] - 2026-07-22

### Added

- Live service and sample progress on interactive terminals, with a quiet mode
for scripts and structured reports.
- Automatic English/Chinese output based on the terminal or macOS system
language, plus `--lang` and `IPCHECK_LANG` overrides.
- A plain-language developer readiness verdict in human, Markdown, and JSON
reports.
- TTY-aware color output with `--color`, `--no-color`, and `NO_COLOR` support.

### Changed

- Human reports now lead with an actionable answer and recommendation.
- Numeric output always uses a dot decimal separator, independent of locale.

## [0.3.0] - 2026-07-22

### Added
Expand Down Expand Up @@ -37,5 +54,6 @@ All notable changes to ipcheck are documented here. The project follows
- Homebrew and direct-download packaging.
- Median/P95 TTFB, jitter, reference bandwidth, and macOS `networkQuality`.

[0.4.0]: https://github.com/jacklv-coder/ipcheck/compare/v0.3.0...v0.4.0
[0.3.0]: https://github.com/jacklv-coder/ipcheck/compare/v0.2.0...v0.3.0
[0.2.0]: https://github.com/jacklv-coder/ipcheck/releases/tag/v0.2.0
20 changes: 17 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,16 @@ Know whether your AI coding CLI is slow, blocked, or using the wrong gateway.
**Codex** and **Claude Code**. It auto-detects installed clients and safe,
non-secret routing configuration, then reports reachability, median/P95
time-to-first-byte (TTFB), jitter, reference bandwidth, and a clear
`GOOD`, `FAIR`, `POOR`, or `BLOCKED` result.
`GOOD`, `FAIR`, `POOR`, or `BLOCKED` result. Interactive runs show live,
color-coded progress and finish with a direct answer to “Ready to code?”.

```text
$ ipcheck --quick
ipcheck v0.3.0 — AI coding network diagnostics
ipcheck v0.4.0 — AI coding network diagnostics

Developer verdict
Ready to code? YES, WITH CAUTION
Development is possible, but responses may feel slower than ideal.

Detected clients
Codex model=gpt-5.6-sol, route=https://chatgpt.com + https://api.openai.com
Expand Down Expand Up @@ -62,7 +67,7 @@ brew install ipcheck

```bash
mkdir -p "$HOME/.local/bin"
curl -fsSL https://raw.githubusercontent.com/jacklv-coder/ipcheck/v0.3.0/bin/ipcheck \
curl -fsSL https://raw.githubusercontent.com/jacklv-coder/ipcheck/v0.4.0/bin/ipcheck \
-o "$HOME/.local/bin/ipcheck"
chmod +x "$HOME/.local/bin/ipcheck"
```
Expand Down Expand Up @@ -101,8 +106,17 @@ ipcheck --samples 10
ipcheck --timeout 30
ipcheck --system
ipcheck --endpoint https://your-gateway.example.com/health
ipcheck --lang zh
ipcheck --no-progress --no-color
```

The human and Markdown reports default to the terminal/system language.
English and Simplified Chinese are currently supported. Override detection with
`--lang en`, `--lang zh`, or `IPCHECK_LANG=en|zh`. JSON field names, enum values,
and diagnostic reasons remain stable English for automation. Progress is written
to stderr only for human output and can be controlled with
`IPCHECK_PROGRESS=auto|always|never`.

Run `ipcheck --help` for the complete option and environment-variable list.

## Supported clients and routes
Expand Down
18 changes: 15 additions & 3 deletions README.zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,16 @@
`ipcheck` 是一个零依赖 Bash 命令行工具,面向 **Codex** 和
**Claude Code** 的真实网络路径。它会自动识别本机客户端以及不含密钥的路由
配置,测量可达性、首字节延迟(TTFB)中位数/P95、抖动和参考带宽,并给出
明确的 `GOOD`、`FAIR`、`POOR` 或 `BLOCKED` 结论。
明确的 `GOOD`、`FAIR`、`POOR` 或 `BLOCKED` 结论。交互运行时会显示带颜色的
实时进度,并直接告诉你“现在是否适合开发”。

```text
$ ipcheck --quick
ipcheck v0.3.0 — AI coding network diagnostics
ipcheck v0.4.0 — AI 编程网络诊断

开发建议
现在适合开发吗?可以,但会有些慢
当前可以开发,但响应速度可能不够理想。

Detected clients
Codex model=gpt-5.6-sol, route=https://chatgpt.com + https://api.openai.com
Expand Down Expand Up @@ -56,7 +61,7 @@ brew install ipcheck

```bash
mkdir -p "$HOME/.local/bin"
curl -fsSL https://raw.githubusercontent.com/jacklv-coder/ipcheck/v0.3.0/bin/ipcheck \
curl -fsSL https://raw.githubusercontent.com/jacklv-coder/ipcheck/v0.4.0/bin/ipcheck \
-o "$HOME/.local/bin/ipcheck"
chmod +x "$HOME/.local/bin/ipcheck"
```
Expand Down Expand Up @@ -93,8 +98,15 @@ ipcheck --samples 10
ipcheck --timeout 30
ipcheck --system
ipcheck --endpoint https://your-gateway.example.com/health
ipcheck --lang en
ipcheck --no-progress --no-color
```

终端和 Markdown 报告默认跟随终端/系统语言,目前支持中文和英文。可以使用
`--lang zh`、`--lang en`,或 `IPCHECK_LANG=zh|en` 明确指定。JSON 的字段名、
枚举值和诊断原因始终保持英文,方便自动化脚本稳定解析。实时进度只会在普通
终端报告中写入 stderr,可通过 `IPCHECK_PROGRESS=auto|always|never` 控制。

运行 `ipcheck --help` 可以查看完整参数。

## 支持的客户端与配置
Expand Down
Loading