Skip to content

anyscale/anyscale-context-kit

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Anyscale Context Kit

Fast, multi-threaded CLI tool to build a unified documentation context for LLM-assisted development with Anyscale.

Purpose

This tool builds a complete documentation context by:

  1. Downloading the entire Anyscale documentation library
  2. Including curated custom documentation (optimizations, best practices, etc.)

The result is a unified context folder ready to provide to AI assistants like Claude Code when working on Anyscale projects.

Use case example:

You: "I've built the Anyscale context at ./anyscale-docs. Use them as
     reference when helping me build my Ray application."

Claude: *Can now reference accurate, up-to-date Anyscale documentation
         plus curated best practices to provide better assistance*

Instead of the AI relying on potentially outdated training data, you get current documentation plus curated optimizations and best practices. This results in more accurate code suggestions, better troubleshooting, and fewer hallucinations.

Quick Start

Install from Git

Option 1: Global Tool (Recommended)

# Install as a global CLI tool from the public repo
uv tool install git+https://github.com/anyscale/anyscale-context-kit.git

# Run from anywhere
asck build-context

Option 2: Project Dependency

# Add to your current project from the public repo
uv add git+https://github.com/anyscale/anyscale-context-kit.git

# Run within your project
uv run asck build-context

Option 3: Using pip

pip install git+https://github.com/anyscale/anyscale-context-kit.git
asck build-context

Option 4: Local Development

git clone https://github.com/anyscale/anyscale-context-kit.git
cd anyscale-context-kit
uv sync
uv run asck build-context

Usage

Basic Commands

# Build context with default settings (fetches docs + bundled custom docs)
asck build-context

# Custom output directory
asck build-context --output-dir ~/my-context

# Include archive section
asck build-context --include-archive

# Include base images
asck build-context --include-base-images

# Build everything (all docs + custom)
asck build-context --include-archive --include-base-images

# Use your own custom docs folder
asck build-context --custom-folder ~/my-custom-docs

# Show help
asck build-context --help

Options

Option Description Default
--output-dir PATH Output directory anyscale-docs
--custom-folder PATH Custom docs to include Bundled custom folder
--include-archive Include archived docs Excluded
--include-base-images Include base images Excluded

What Gets Built

Anyscale Documentation (183 docs by default): Administration, CI/CD, Configuration, Container Images, Development, Get Started, IAM, LLM, Machine Pools, Monitoring, Platform, Reference, Secrets, Services, Tutorials

Custom Documentation (bundled):

  • Optimizations and best practices
  • Additional guides and examples
  • Any custom content in the custom/ folder

Optional sections:

  • --include-archive: 155 archived/deprecated docs
  • --include-base-images: 123 base image reference docs

Output Structure

anyscale-docs/
├── administration/          # Fetched Anyscale docs
│   ├── billing/
│   │   ├── budgets.md
│   │   └── ...
│   └── ...
├── get-started/
├── llm/
├── optimizations/           # Bundled custom docs
│   └── ray-data-optimizations.md
└── ...

Troubleshooting

Can't install uv?

# Alternative: use pip
pip install git+https://github.com/anyscale/anyscale-context-kit.git
asck build-context

Slow downloads?

  • Check internet connection
  • Server may be experiencing high load

Features

  • Fast: Multi-threaded downloads
  • 📁 Organized: Preserves hierarchical folder structure
  • 📚 Unified Context: Combines official docs + curated best practices
  • ⚙️ Configurable: Custom paths, sections, and custom docs
  • 📊 Progress: Real-time download status
  • 🎯 Selective: Include/exclude specific sections

Requirements

  • Python 3.12+
  • ~50-80MB disk space
  • Internet connection

License: MIT (see LICENSE)

About

Downloads Anyscale Docs to create local context for LLMs

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages