Metadata-Version: 2.4
Name: research-skills-installer
Version: 0.1.0b11
Summary: Installer/upgrader CLI for research-skills (Codex / Claude Code / Gemini) without requiring a git fork.
Author: Jiaxin Peng
License-Expression: MIT
Project-URL: Homepage, https://github.com/jxpeng98/research-skills
Project-URL: Repository, https://github.com/jxpeng98/research-skills
Project-URL: Bug Tracker, https://github.com/jxpeng98/research-skills/issues
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Scientific/Engineering
Requires-Python: >=3.12
Description-Content-Type: text/markdown
License-File: LICENSE
Dynamic: license-file

# research-skills-installer

`research-skills-installer` is a lightweight CLI for installing and upgrading **Research Skills** assets in your project for Codex, Claude Code, and Gemini workflows.

## What it does

- Install workflow/skill assets into your project
- Upgrade assets to newer upstream versions
- Support `codex`, `claude`, `gemini`, or `all` targets
- Run doctor checks before/after installation

## Installation

```bash
pip install research-skills-installer
```

Or with `pipx`:

```bash
pipx install research-skills-installer
```

## CLI

Main command and aliases:

- `research-skills`
- `rsk`
- `rsw`

### Check updates

```bash
rsk check
```

### Upgrade assets

```bash
rsk upgrade --project-dir /path/to/project --target all --doctor
```

The package includes a default upstream repo (`jxpeng98/research-skills`), so `--repo` is optional.
Use `--repo` only when you want to override the default.

## Override default repo (optional)

The CLI resolves upstream repo in this order:

1. `--repo` argument
2. `RESEARCH_SKILLS_REPO` environment variable
3. `research-skills.toml` or `.research-skills.toml` in your project path
4. Packaged default (`research_skills/project.toml`)

### Option A: Global override

Add this to your shell profile (`~/.zshrc`, `~/.bashrc`, etc.):

```bash
export RESEARCH_SKILLS_REPO="<owner>/<repo>"
```

Then reload shell:

```bash
source ~/.zshrc
```

Now you can run:

```bash
rsk check
rsk upgrade --project-dir /path/to/project --target all --doctor
```

### Option B: Project-level override

Create `research-skills.toml` in your project root:

```toml
[upstream]
repo = "jxpeng98/research-skills"
url = "https://github.com/<owner>/<repo>"
```

This keeps the override local to that project.

## Typical usage

```bash
# Install from PyPI
pipx install research-skills-installer

# Upgrade assets into your project
rsk upgrade --project-dir /path/to/project --target all --doctor
```

## Links

- Repository: https://github.com/jxpeng98/research-skills
- Issues: https://github.com/jxpeng98/research-skills/issues
