πŸš€ Getting Started

πŸ“‹ Overview

DocSense is a command-line tool that helps you create a searchable knowledge base from your documents and interact with them using natural language queries.

🎯 Quick Start

  1. Install DocSense πŸ“₯

pip install docsense

  1. Index Your Documents πŸ“š

# Index a directory of documents
docsense index ./docs

# Index with custom settings
docsense index ./docs --model-name "Qwen/Qwen2-7B" --device cpu

  1. Ask Questions πŸ’¬

# Ask a simple question
docsense ask "What are the key points in the documentation?"

# Use different model or device
docsense ask "Explain the architecture" --device cpu --model-name "custom-model"

# Run in daemon mode for faster consecutive queries
docsense daemon

πŸ”§ Command Reference

Index Command

# Basic usage
docsense index <directory>

# Options
  --model-name TEXT     Model to use for embeddings
  --device TEXT        Computing device (cuda/cpu)
  --index-path PATH    Custom index location
  --help              Show this message and exit

Ask Command

# Basic usage
docsense ask <question>

# Options
  --model-name TEXT    Model to use for answering
  --device TEXT       Computing device (cuda/cpu)
  --index-path PATH   Custom index location
  --help             Show this message and exit

Daemon Command

# Basic usage
docsense daemon

# Options
  --model-name TEXT    Model to use
  --device TEXT       Computing device (cuda/cpu)
  --index-path PATH   Custom index location
  --help             Show this message and exit

πŸ“ Example Use Cases

  1. Documentation Search πŸ“–

# Index technical docs
docsense index ./technical-docs

# Search for specific information
docsense ask "How do I configure the logging system?"

  1. Interactive Mode πŸ”„

# Start daemon mode for faster responses
docsense daemon --device cpu

# Then ask questions interactively
> How do I get started?
> What are the main features?
> exit  # to quit

πŸ” Next Steps