ros CLI

Command-line tool for the ros-api academic resource query service.

Installation

pip install git+https://github.com/Shannon4Science/ros-cli.git

Or install from local source:

git clone https://github.com/Shannon4Science/ros-cli.git
cd ros-cli
pip install -e .

Quick Start

# Configure API Key (interactive)
ros config init

# Search metadata by title
ros metadata query --search "title:machine learning"

# Fetch a paper by DOI
ros metadata fetch --doi "10.1590/1806-9126-rbef-2022-0101"

# Fetch content by SHA256
ros content fetch --sha256 "dee1a64db5c1117b..."

Configuration

Config is stored at ~/.ros/config.json. You can set it interactively or directly:

ros config init          # Interactive setup
ros config set-key KEY   # Set API key directly
ros config set-url URL   # Set base URL
ros config show          # Show current config

To obtain an API key, visit: https://docs.ros.shlab.tech:18443/concepts/authentication/#get-api-key

Commands

Metadata

Command	Description
ros metadata query	Search/filter metadata with pagination
ros metadata fetch	Fetch single metadata by DOI or ISBN
ros metadata batch-fetch	Batch fetch multiple metadata records

Content

Command	Description
ros content query	Search/filter content resources
ros content fetch	Fetch single content by SHA256
ros content batch-fetch	Batch fetch multiple content records

Output Formats

Use --output to control output format:

• json (default) - Full JSON output
• table - Formatted table using rich
• compact - One-line-per-result summary

Agent Skill Integration

This CLI is designed to be used as a skill by AI coding agents: Cursor, Codex, OpenClaw, and Claude Code.

The bundled skill templates require the ros CLI to be installed locally before the skill is actually usable. Installing a skill file only adds agent instructions; it does not make lookups work by itself.

Required before first use:

pip install --upgrade git+https://github.com/Shannon4Science/ros-cli.git
ros config init

Method 1: CLI command (recommended)

Install the CLI first, then let the CLI place the correct skill template:

pip install --upgrade git+https://github.com/Shannon4Science/ros-cli.git
ros skill install                      # Auto-detect platform
ros skill install --platform cursor    # Cursor only
ros skill install --platform codex     # Codex only
ros skill install --platform openclaw  # OpenClaw only
ros skill install --platform claude    # Claude Code only
ros skill install --platform all       # All platforms

Method 2: Quick Install template only

This installs the skill file without pip-installing the CLI. You must still install the CLI before using the skill:

# Linux / macOS
curl -sSL https://raw.githubusercontent.com/Shannon4Science/ros-cli/main/scripts/quick_install.py | python3

# Windows PowerShell
irm https://raw.githubusercontent.com/Shannon4Science/ros-cli/main/scripts/quick_install.py -OutFile qi.py; python qi.py; del qi.py

# Specify platform
curl -sSL https://raw.githubusercontent.com/Shannon4Science/ros-cli/main/scripts/quick_install.py | python3 - --platform openclaw

After template installation, install and configure the CLI:

pip install --upgrade git+https://github.com/Shannon4Science/ros-cli.git
ros config init

Method 3: Manual download template only

Download individual templates directly:

# Cursor
mkdir -p ~/.cursor/skills/ros-api
curl -sSL https://raw.githubusercontent.com/Shannon4Science/ros-cli/main/ros_api/skills/cursor_skill.md \
  -o ~/.cursor/skills/ros-api/SKILL.md

# Codex
mkdir -p ~/.codex/skills/ros-api
curl -sSL https://raw.githubusercontent.com/Shannon4Science/ros-cli/main/ros_api/skills/codex_skill.md \
  -o ~/.codex/skills/ros-api/SKILL.md

# OpenClaw
mkdir -p ~/.openclaw/skills/ros-api
curl -sSL https://raw.githubusercontent.com/Shannon4Science/ros-cli/main/ros_api/skills/openclaw_skill.md \
  -o ~/.openclaw/skills/ros-api/SKILL.md

# Claude Code (save to project root)
curl -sSL https://raw.githubusercontent.com/Shannon4Science/ros-cli/main/ros_api/skills/claude_agents.md \
  -o AGENTS.md

After manual template installation, install and configure the CLI:

pip install --upgrade git+https://github.com/Shannon4Science/ros-cli.git
ros config init

Supported platforms

Platform	Target path
Cursor	~/.cursor/skills/ros-api/SKILL.md
Codex	~/.codex/skills/ros-api/SKILL.md
OpenClaw	~/.openclaw/skills/ros-api/SKILL.md
Claude Code	./AGENTS.md (current directory)

Bundled templates

• ros_api/skills/cursor_skill.md - Cursor SKILL.md
• ros_api/skills/codex_skill.md - Codex SKILL.md
• ros_api/skills/openclaw_skill.md - OpenClaw SKILL.md
• ros_api/skills/claude_agents.md - Claude Code AGENTS.md
• AGENTS.md - Claude Code integration (repo root copy)

For maintainers: edit ros_api/skills/shared_skill_body.md and regenerate the bundled templates with python scripts/render_skill_templates.py.