Quick Start Guide

This guide covers the essential steps to get up and running with ContextCraft quickly.

1. Launch ContextCraft

After installing ContextCraft, launch the application:

• On macOS: Open it from your Applications folder or Launchpad
• On Windows: Open it from the Start menu or desktop shortcut

2. Select a Project Folder

The first step is to select a folder containing the code you want to share with an AI model:

1. Click the Select Folder button in the sidebar.
2. Navigate to your project's root directory using the file browser.
3. Click Open to load the project.

ContextCraft will scan your project's directory structure and display all files that aren't excluded by ignore patterns.

3. Select Files

Once your project is loaded, you need to select the specific files you want to include in your code export:

Individual Files

1. Browse the file tree to find relevant files.
2. Click the checkbox next to each file name to select it.
3. Selected files will be highlighted in the file tree.

Entire Directories

1. To include all files in a directory, click the checkbox next to the directory name.
2. All files within that directory (except those excluded by ignore patterns) will be selected.

Quick Search

If you have a large project and need to find specific files:

1. Use the search bar at the top of the sidebar.
2. Enter keywords to filter files and directories.
3. Select the relevant files from the filtered results.

4. Configure Output Options

In the right panel (Control Container), configure your output options:

1. File Tree Mode: Choose how to display your project structure:

   • None: No file tree is included
   • Selected Only: Only selected files appear in the tree
   • Selected with Path: Shows selected files with their parent directories
   • Complete Tree: Displays your entire project structure

2. Model: Select your target AI model to optimize for token limits.

3. Output Format: Choose between XML, Markdown, or Plain Text.

4. Optimization (optional):

   • Toggle Compression to reduce token usage by simplifying function bodies.
   • Toggle Remove Comments to further reduce token usage.

5. Add Instructions (Optional)

If you want to include specific questions, context, or instructions for the AI:

1. Toggle Show Instructions to display the instructions panel.
2. Enter your text in the text area that appears.
3. Your instructions will be included with your code when exported.

6. Export Your Code

Once you've selected files and configured options:

1. Click the Copy button to copy the formatted output to your clipboard.
2. Alternatively, click the Download button to save the output as a file.

7. Share with AI

1. Go to your preferred AI platform (like ChatGPT, Claude, etc.)
2. Paste the copied content into a new message.
3. Send your message and wait for the AI to process your code.

Quick Tips

• Monitor the token count: The bar at the bottom of the Control Container shows your token usage against your selected model's limit.
• Use compression: For large projects, enable code compression to include more files within token limits.
• Save your workspace: ContextCraft automatically remembers your selected files and settings between sessions.
• Exclude irrelevant files: Use Ignore Patterns to exclude node_modules, build files, and other non-essential code.

---

Next Steps: For a detailed explanation of the application interface, see the User Interface Overview.