Skip to content

Commit 9741d28

Browse files
committed
chore: sync version to 1.2.0 and update README
- Update package.json version to 1.2.0 (sync with npm) - Add comprehensive installation guide in README - Clarify package naming (npm: astroquery-cli, PyPI: aqc-cli) - Document all three available commands
1 parent 6f22d69 commit 9741d28

2 files changed

Lines changed: 61 additions & 19 deletions

File tree

README.md

Lines changed: 59 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -57,39 +57,81 @@ Query data from 17 different astronomical databases and services:
5757

5858
## 📦 Installation
5959

60-
### Quick Start (via npx/pnpm)
60+
Astro CLI 提供多种安装方式,选择适合你的方式:
6161

62-
Requires: Node.js ≥18 and Python 3.11+
62+
### 方式一:npm 全局安装(推荐)
6363

6464
```bash
65-
# Using pnpm (recommended)
66-
pnpm astrocli --help
65+
# 全局安装(需要 Node.js ≥18 和 Python 3.11+)
66+
npm install -g astroquery-cli
6767

68-
# Using npx
69-
npx astrocli --help
68+
# 安装后可使用以下任一命令:
69+
astroquery-cli --help # 完整命令
70+
aqc --help # 短命令
71+
astrocli --help # 别名命令
7072

71-
# Example: Query SIMBAD for M31
72-
pnpm astrocli simbad object "M31"
73+
# 示例:查询 SIMBAD 中的 M31
74+
astrocli simbad object "M31"
75+
```
76+
77+
### 方式二:npx/pnpm 直接运行
78+
79+
```bash
80+
# 使用 npx(无需安装)
81+
npx astroquery-cli --help
82+
83+
# 使用 pnpm
84+
pnpm astroquery-cli --help
85+
86+
# 示例
87+
npx astroquery-cli simbad object "M31"
7388
```
7489

75-
### Environment Variables
90+
### 方式三:PyPI 安装(Python 用户)
7691

77-
- `AC_PYTHON` - Specify Python interpreter path
78-
- `AC_VENV_DIR` - Custom virtual environment cache directory (default: `~/.cache/astrocli`)
79-
- `AC_FORCE_INSTALL=1` - Force reinstall/upgrade Python dependencies
80-
- `AC_DEBUG` - Enable debug mode
81-
- `AC_LANG` - Set default language (en/zh/ja)
92+
```bash
93+
# 从 PyPI 安装 Python 包
94+
pip install aqc-cli
95+
96+
# 安装后可使用命令:
97+
aqc --help
98+
astrocli --help
99+
```
82100

83-
### Install from Source
101+
### 方式四:从源码安装
84102

85103
```bash
86-
git clone https://github.com/yourusername/astrocli.git
87-
cd astrocli
104+
git clone https://github.com/inoribea/astroquery-cli.git
105+
cd astroquery-cli
88106
pip install -e .
89107
```
90108

91109
---
92110

111+
### 📋 包名说明
112+
113+
| 平台 | 包名 | 安装命令 |
114+
|------|------|---------|
115+
| **npm** | `astroquery-cli` | `npm install -g astroquery-cli` |
116+
| **PyPI** | `aqc-cli` | `pip install aqc-cli` |
117+
118+
安装后,三个命令均可使用:
119+
- `astroquery-cli` - 完整命令名
120+
- `aqc` - 短命令(推荐)
121+
- `astrocli` - 别名命令
122+
123+
---
124+
125+
### 环境变量
126+
127+
- `AC_PYTHON` - 指定 Python 解释器路径
128+
- `AC_VENV_DIR` - 自定义虚拟环境缓存目录(默认:`~/.cache/astrocli`
129+
- `AC_FORCE_INSTALL=1` - 强制重新安装/升级 Python 依赖
130+
- `AC_DEBUG` - 启用调试模式
131+
- `AC_LANG` - 设置默认语言(en/zh/ja)
132+
133+
---
134+
93135
## 📚 Usage
94136

95137
### View All Available Commands

package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "astroquery-cli",
3-
"version": "1.0.0",
4-
"description": "npx-friendly wrapper for the astroquery-cli Python tool",
3+
"version": "1.2.0",
4+
"description": "Command-line interface for querying astronomical databases via astroquery",
55
"bin": {
66
"astroquery-cli": "./npx-entry.js",
77
"aqc": "./npx-entry.js",

0 commit comments

Comments
 (0)