English | 中文
Arxtect is a LaTeX compiler for VS Code powered by WebAssembly. It runs inside the editor, supports pdfTeX and XeTeX, and does not require a local TeX Live installation.
Install
- Install Arxtect from the VS Code Marketplace, or run
Extensions: Install from VSIX...to install a local.vsixpackage. - Requires VS Code 1.93.0 or later.
- No local TeX Live installation is required. Internet access may be needed the first time Arxtect downloads TeX Live package files into its local cache.
Quick Start
- Open a folder that contains your
.texproject. - Open the main
.texfile. - Run
Arxtect: Compile LaTeXfrom the Command Palette, or pressCtrl+Alt+B(Cmd+Alt+Bon macOS). - Open the generated PDF from the notification, the sidebar, or
Arxtect: Open PDF. - For multi-file projects, run
Arxtect: Set Main TeX Fileso Arxtect always compiles the correct entry file.
Features
Compilation
- Compile
.texfiles directly in VS Code with WebAssembly. - Choose pdfTeX or XeTeX from commands, settings, or the sidebar.
- Run multi-pass compilation for cross-references and labels.
- Enable compile-on-save when you want automatic builds.
- Configure compile timeout and auto-open PDF behavior.
- Set a main TeX file for multi-file projects.
Language Tools
- Completion for LaTeX commands, environments, packages, labels, and citations.
- Hover information for common commands, environments, and packages.
- Go to definition for labels, citations, and included files.
- Find references and rename labels across matching references.
- Document symbols, workspace symbols, pair highlights, document links, folding, smart selection, and basic formatting.
- Code actions for common LaTeX issues.
PDF, Logs, And Utilities
- Open the compiled PDF from Arxtect commands or the sidebar.
- Use SyncTeX commands to jump between source and PDF positions.
- View diagnostics in the Problems panel.
- Show or export the compilation log.
- Clean auxiliary files such as
.aux,.log,.toc, and.synctex.gz. - Count words and characters in the current LaTeX document.
Interface
- Sidebar with compile controls, diagnostics, logs, settings, account, and quota status.
- Standalone panel view when you prefer a larger control surface.
- Status bar indicator for compile state and selected engine.
- English and Chinese UI localization.
Commands
| Command | Keybinding | Description |
|---|---|---|
Arxtect: Compile LaTeX |
Ctrl+Alt+B / Cmd+Alt+B |
Compile with the default engine. |
Arxtect: Compile with pdfTeX |
Compile with pdfTeX. | |
Arxtect: Compile with XeTeX |
Compile with XeTeX. | |
Arxtect: Multi-pass Compile |
Compile multiple passes to resolve references. | |
Arxtect: Show Panel |
Open the standalone Arxtect panel. | |
Arxtect: Focus Sidebar |
Focus the Arxtect sidebar. | |
Arxtect: Show Compilation Log |
Show the output channel. | |
Arxtect: Open PDF |
Open the last compiled PDF. | |
Arxtect: SyncTeX Forward (TeX -> PDF) |
Ctrl+Alt+J / Cmd+Alt+J |
Jump from source to PDF position. |
Arxtect: SyncTeX Inverse (PDF -> TeX) |
Jump from PDF position to source. | |
Arxtect: Set Main TeX File |
Set the project entry file. | |
Arxtect: Clear Main TeX File |
Clear the configured main file. | |
Arxtect: Clean Auxiliary Files |
Remove generated auxiliary files. | |
Arxtect: Export Compilation Log |
Save the compile log to a file. | |
Arxtect: Word Count |
Show word and character counts. | |
Arxtect: Log in with GitHub |
Sign in to your Arxtect account. | |
Arxtect: Log out |
Sign out of your Arxtect account. | |
Arxtect: Show Compile Quota |
Show current compile quota status. | |
Arxtect: Upgrade to Premium |
Open the upgrade page. |
Settings
| Setting | Default | Description |
|---|---|---|
arxtect.defaultEngine |
xetex |
Default LaTeX engine: pdftex or xetex. |
arxtect.texliveEndpoint |
"" |
Custom TeX Live package endpoint URL. |
arxtect.autoCompile |
false |
Compile automatically when a TeX file is saved. |
arxtect.openPdfAfterCompile |
true |
Open the PDF after a successful compilation. |
arxtect.compileTimeout |
120 |
Compile timeout in seconds, from 10 to 600. |
arxtect.maxCompilePasses |
3 |
Maximum passes for multi-pass compile, from 1 to 5. |
Troubleshooting
- If Arxtect compiles the wrong file, run
Arxtect: Set Main TeX File. - If a build times out, increase
arxtect.compileTimeout. - If old output keeps appearing, run
Arxtect: Clean Auxiliary Filesand compile again. - If package downloads fail, check your network or configure
arxtect.texliveEndpoint. - For compile details, run
Arxtect: Show Compilation Log.
Support
Please report issues at Arxtect VS Code Extension Issues.
License
MIT