Installation Guide

This guide will walk you through the process of installing TeXRA and all its dependencies to ensure optimal performance.

System Requirements

TeXRA is designed to work on all major operating systems with the following minimum requirements:

• Visual Studio Code: Version 1.96.2 or newer
• Operating System: Windows, macOS, or Linux
• Internet Connection: Required for API access to language models

Installing the Extension

From Extension Marketplaces

The easiest way to install TeXRA is directly from an extension marketplace:

1. Open VS Code or your VSCodium-compatible editor.
2. Go to the Extensions view (click the square icon in the Activity Bar or press Ctrl+Shift+X).
3. Search for "TeXRA".
4. Find the extension published by "texra-ai".
5. Click the "Install" button.
6. Reload your editor if prompted.

TeXRA is available on both the official VS Code Marketplace and the Open VSX Registry:

View on VS Code MarketplaceView on Open VSX

From VSIX File

1. Open VS Code
2. Obtain the newest release (.vsix file, e.g., texra-0.28.0.vsix)
3. Find the .vsix file in the VS Code file explorer
4. Right-click on the .vsix file
5. From the context menu, select "Install Extension VSIX"

Installing Required Dependencies

Now for the slightly less fun part – making sure TeXRA has all the tools it needs to work its magic. TeXRA relies on several external tools to function properly. Follow the instructions for your operating system.

LaTeX Distribution

IMPORTANT

A LaTeX distribution is required for TeXRA to properly process LaTeX documents.

Windows

Install either:

• MiKTeX: Download and install from miktex.org
• TeX Live: Download and install from tug.org/texlive/windows.html

macOS

Install MacTeX:

• Download from tug.org/mactex/mactex-download.html
• Or use Homebrew: brew install --cask mactex

Linux (Ubuntu/Debian)

Install TeX Live:

sudo apt-get update
sudo apt-get install texlive-full

Perl

INFO

Perl is required for LaTeX tools and document processing.

Windows

• Included with MiKTeX or TeX Live
• Verify installation by running perl --version in Command Prompt

macOS

• Pre-installed
• Verify with perl --version in Terminal

Linux

sudo apt-get install perl

GraphicsMagick/ImageMagick

RECOMMENDED

GraphicsMagick is the recommended option for better performance.

GraphicsMagick

Windows:

• Download from GraphicsMagick website
• Add installation directory to PATH

macOS:

brew install graphicsmagick

Linux:

sudo apt-get install graphicsmagick

ImageMagick (Alternative)

Windows:

• Download from ImageMagick website
• Follow the detailed installation guide

macOS:

brew install imagemagick

Linux:

sudo apt-get install imagemagick

Ghostscript

REQUIRED

Ghostscript is required by GraphicsMagick/ImageMagick for PDF processing.

Windows

• Download from Ghostscript website
• For compatibility issues, you might need to install version 9.52 from this link

macOS

brew install ghostscript

Linux

sudo apt-get install ghostscript

Setting Up API Keys

TeXRA requires API keys to access language models. Here's how to set them up:

1. Open VS Code with TeXRA installed
2. Click on the TeXRA icon in the Activity Bar
3. Click "Set API Key" in the TeXRA panel
4. Select the provider (OpenAI or Anthropic)
5. Enter your API key when prompted

Alternatively, you can access the extension settings (including API key setup) by clicking the gear icon () in the TeXRA webview panel.

Getting API Keys

• OpenAI API Key: Available from OpenAI API
• Anthropic API Key: Available from Anthropic Console
• Google API Key: Available from Google AI Studio

Verifying Installation

To verify that TeXRA and all dependencies are correctly installed:

1. Open VS Code
2. Click on the TeXRA icon in the Activity Bar
3. The TeXRA panel should load without errors
4. Create or open a LaTeX document
5. Try a simple command like "Indent Current TeX" from the editor title menu

If any component is missing, TeXRA will typically show an error message indicating what needs to be installed.

Troubleshooting Installation

Common Installation Issues

1. Extension Not Loading:

   • Check VS Code's minimum version requirement (1.94.2+)
   • Look for errors in the Output panel (select "TeXRA" in the dropdown)
   • Try reinstalling the extension

2. LaTeX Processing Errors:

   • Verify LaTeX is in your system PATH
   • Run pdflatex --version in terminal to confirm installation
   • Check if required LaTeX packages are installed

3. Image Processing Errors:

   • Confirm GraphicsMagick/ImageMagick is properly installed
   • Verify Ghostscript is installed and accessible
   • Check PATH environment variables

4. API Key Issues:

   • Verify API keys are entered correctly
   • Check your usage limits
   • Ensure your network allows connections to API endpoints

Getting Help

If you encounter persistent installation issues:

1. Check the GitHub Issues page for known problems
2. Look for error messages in the TeXRA ProgressBoard
3. File a new issue with detailed information about your system and the specific error

Next Steps

With TeXRA and all dependencies installed, you're ready to start using the tool to enhance your academic research. Check out the Quick Start Guide to learn the basics, or explore specific features in the other documentation sections.