Skip to content

User Guide

Jump to bottom
Yiğit ERDOĞAN edited this page Jan 11, 2026 · 1 revision

📖 User Guide

Welcome to the CodeScope User Guide. This document explains how to get the most out of your AI-powered coding assistant.

Table of Contents

  1. Indexing a Repository
  2. Chatting with Your Code
  3. Exploring Files
  4. Using the Circuit Board UI
  5. Keyboard Shortcuts

Indexing a Repository

Before you can chat with your code, CodeScope needs to understand it.

  1. Open Settings: Click the ⚙️ icon in the top right.
  2. Enter Path: Type or paste the absolute path to your local repository.
    • Example: /home/user/projects/my-app or C:\\Projects\\my-app
  3. Ingest: Click "Ingest Repository".
  4. Monitor: The console and UI will show progress. Large repositories may take a few minutes.

Note: Ingesting a new repository replaces the previous index.

Chatting with Your Code

The main interface is a chat window designed for natural language queries.

What to Ask?

  • Summarization: "What does this project do?"
  • Logic Explanation: "How is the authentication handled?"
  • Bug Finding: "Are there any security vulnerabilities in the database logic?"
  • Refactoring: "How can I make the User class more efficient?"
  • Boilerplate: "Write a new API endpoint for fetching logs."

Tips for Better Answers

  • Be Specific: Mention file names or function names if you know them.
  • Ask for Code: "Show me the implementation of..."
  • Iterate: Follow up on AI answers to dive deeper.

Exploring Files

The sidebar on the left allows you to navigate your repository's structure.

  • Cloud Icons: Represents folders.
  • File Icons: Represents code files.
  • Click to View: Open any file to see its content alongside the chat.

Using the Circuit Board UI

CodeScope features a unique, animated circuit board background that reacts to system state.

  • Static: Idle state.
  • Animated: Highlighting AI processing or ingestion activity.

Keyboard Shortcuts

Shortcut Action
Enter Send message
Shift + Enter New line in chat
Ctrl + L Clear chat history
Esc Close current file view

Next Steps

Clone this wiki locally