Documentation

Master Cheetah AI

⌘K

Getting Started

Learn the basics of working with Cheetah AI effectively

Making Clear Requests

Essential

Master the art of communicating with AI. Clear, specific requests lead to exceptional results.

Excellent Examples

Specific & Actionable

"Create a React component for a user profile card with name, email, avatar, and follow button with hover effects"

Includes Context

"Using Next.js 14, implement JWT auth with refresh tokens for my e-commerce API"

Avoid These

Too Vague

"Make my website better"

No Context

"Fix this bug"

💡 Pro Communication Tips

  • •Be specific about your goals
  • •Mention your tech stack
  • •Include error messages
  • •Specify experience level

Sharing Context

Effectively share context and background information with Cheetah AI for better understanding.

Context Best Practices

Maximize the effectiveness of Cheetah AI's context understanding.

Smart Context Usage

  • •Mention specific file paths or directories
  • •Share function or class names
  • •Include relevant error messages
  • •Describe the expected behavior

Provide Context

  • •Explain what you're trying to achieve
  • •Share your current environment
  • •Include relevant code snippets
  • •Describe your project structure

Context Examples

✅ Good Context Request

"The user authentication in /src/auth/login.js is authentication middleware in the loginAuth folder. I'm getting JWT validation errors and need to understand how tokens are being processed across different modules."

❌ Vague Context Request

"Look at my code and fix the auth issues."

Task Breakdown

Learn how to break down complex tasks into manageable, actionable steps.

Effective Task Breakdown Examples

Large Feature Development

"I need to build a user dashboard. Let's break this into: authentication, user profile management, data visualization components, and settings page."

Database Design

"For my e-commerce app, help me design tables for: users, products, orders, payments, and inventory tracking."

Code Refactoring

"My component is too complex. Let's break it down: extract custom hooks, separate UI components, add error boundaries, and optimize performance."

API Development

"I need a REST API for my blog. Let's plan: user auth endpoints, CRUD for posts, comment system, and file upload handling."

Context Engine

Advanced retrieval and understanding capabilities

Context Retrieval

Advanced

Harness the power of AI-driven context analysis to understand and navigate your codebase intelligently.

Quick Start

// Using @codebase to analyze your entire project
@codebase explain the authentication flow

// Context-aware suggestions  
@codebase what patterns are used in this project?

// Architecture analysis
@codebase analyze the component structure

Perfect Use Cases

  • •Understanding large codebases
  • •Finding related functions
  • •Analyzing patterns & architecture
  • •Cross-file debugging

Example Prompts

"Find all API endpoints for users"

"Show error handling patterns"

"Explain React data flow"

💡 Pro Tip

Combine context retrieval with specific file paths for laser-focused analysis. For example: "Use context retrieval to analyze authentication in /src/auth folder"

AI Modes

Choose the right mode for your task - Plan vs Act

When to Use Plan Mode

Strategic planning mode for complex tasks requiring careful analysis.

Perfect for Plan Mode

•

Building full applications from scratch

•

Restructuring existing codebases

•

Database schema design

•

API planning and endpoint structure

•

Technology stack selection

•

Learning & explanation

•

Understanding new frameworks or libraries

•

Research-heavy tasks and outlining

•

Technology comparisons and evaluations

•

Performance optimization planning

Plan Mode Examples

Architecture Planning

"I want to plan out how to build a real-time chat application. Help me think through the architecture - should I use WebSockets or Socket.io? How should I structure the database for messages and user sessions?"

Technology Evaluation

"I need to choose between Next.js and Nuxt.js for my e-commerce project. Can you help me compare them based on my requirements: SSR, SEO optimization, and payment integration?"

Refactoring Strategy

"My React app has become difficult to maintain. Help me plan a refactoring strategy to improve code organization, implement state management, and optimize performance."

When to Use Act Mode

Execution mode for immediate implementation and direct action.

Perfect for Act Mode

•

Bug fixes and error resolution

•

Adding new features to existing projects

•

Code refactoring and optimization

•

File creation and project setup

•

Configuration and deployment tasks

•

Clear Requirements

•

You know exactly what you want

•

Working on defined tasks

•

Following established patterns

•

Quick modifications and updates

•

Testing and debugging specific issues

Act Mode Examples

Bug Fix

"Fix the login form validation in auth.js - it's not checking for empty email fields and allowing invalid submissions."

Feature Addition

"Add a dark mode toggle to the header component with localStorage persistence and smooth transitions."

Code Refactoring

"Extract the API calls from UserProfile.tsx into a separate custom hook and implement proper error handling."

Configuration

"Set up ESLint and Prettier configuration for my TypeScript React project with strict rules."

Commands

Quick actions and shortcuts for efficient workflow

Command Basics

Master essential commands for streamlined development workflow.

Essential Commands

@codebase

Analyze your entire project structure and find patterns

@file

Reference specific files in your requests

@docs

Access documentation and examples

@terminal

Execute terminal commands and scripts

Command Examples

Real-world examples of effective command usage.

Practical Examples

Project Analysis

@codebase analyze the authentication flow in this React app

File-Specific Help

@file src/components/Header.tsx optimize this component for performance

Documentation Search

@docs show me examples of React hooks best practices

Best Practices

Essential guidelines for optimal results

Development Best Practices

Follow these guidelines to get the most out of Cheetah AI.

Communication

•

Be specific about requirements

•

Provide context and background

•

Ask follow-up questions

•

Share error messages in full

Code Quality

•

Request code reviews

•

Ask for performance optimization

•

Include testing strategies

•

Focus on maintainability

⭐

Must-Know Tips

These practices will significantly improve your experience with Cheetah AI:

  • • Always specify your programming language and framework
  • • Share your project structure when asking about architecture
  • • Include relevant dependencies and versions
  • • Break complex requests into smaller, focused questions

Cheetah Code Stick

Our innovative sticky code display keeps your most important code snippets visible as you scroll through documentation.

Key Features

Sticky Positioning

Code remains visible as you scroll

AI Precision

Optimized by our AI for best practices

Easy Copy & Run

One-click copy and execution

Cheetah Speed

Instant access without losing context

Try It Yourself

Scroll up and down to see the sticky code component in action on this page. Notice how it remains visible even as you navigate through different sections of content.