Repository navigation
Visual Studio Code The Ultimate Developer Setup Guide
Visual Studio Code (VS Code) is the industry standard for modern software development. Whether you are building web applications, writing Python scripts, or managing embedded systems, a properly configured VS Code environment will exponentially increase your productivity.
A one-time setup guide to take a bare VS Code install to a fully-configured workstation covering general software development, GitHub integration, embedded/microcontroller development, and AI-assisted coding - the baseline environment referenced elsewhere in this repo (e.g., arduinoIDE.md) rather than a language-specific guide.
Five sequential setup steps: core editor settings (autosave, format-on-save), general-purpose extensions (formatting, error highlighting, language packs), GitHub integration (PRs/Issues, GitLens), embedded development via PlatformIO, and an optional AI assistant layer (Copilot, Gemini Code Assist, Claude Code, Cline).
Get a new machine from a fresh VS Code install to a fully productive dev environment in one pass, without needing to rediscover the same dozen extensions and settings tweaks every time.
- Setting up a new development machine or VM
- Onboarding - hand this to anyone joining a project as the baseline environment doc
- Adding embedded/microcontroller support to an existing VS Code install (Step 4), which pairs with
arduinoIDE.mdin this same folder
Before adding extensions, optimize the core editor for a better developer experience.
- Download and install Visual Studio Code.
- Open settings (
Ctrl+,orCmd+,) and tweak these crucial defaults:-
Auto Save: Set to
onFocusChangeorafterDelay. - Format on Save: Checked (Automates code formatting every time you save).
-
Word Wrap: Set to
on(Prevents horizontal scrolling on long lines). - Font Size / Line Height: Adjust for readability. (Consider installing a font with programming ligatures like Fira Code).
-
Auto Save: Set to
Click the Extensions icon on the left sidebar (Ctrl+Shift+X / Cmd+Shift+X) and install these baseline tools:
- Prettier - Code formatter: The gold standard for enforcing consistent code style across JavaScript, TypeScript, HTML, CSS, and Markdown.
- Error Lens: Highlights entire lines of code in red/yellow as you type if there is a syntax error, avoiding the need to hover over tiny squiggly lines.
-
TODO Tree: Scans your workspace for comments like
// TODO:or// FIXME:and displays them in a neat sidebar list. -
Language Packs: Install specific language extensions based on your stack:
- Python (by Microsoft)
- C/C++ Extension Pack (by Microsoft)
- ESLint (for JavaScript/TypeScript)
VS Code has excellent built-in Git support, but you can turn it into a complete GitHub workstation.
- GitHub Pull Requests and Issues: Install this official extension by GitHub. It allows you to review pull requests, comment on code, and manage issues directly within the editor without opening a browser.
- GitLens - Git supercharged: An absolute must-have. It adds inline "blame" annotations (showing who last modified a line and when), a visual commit graph, and advanced file history exploration.
-
Authentication: * Click the Accounts icon (bottom left profile icon).
- Select Sign in with GitHub to use GitHub Pull Requests and Issues.
- Follow the browser prompts to authorize VS Code.
Workflow Tip: Use the Source Control tab (Ctrl+Shift+G) to stage changes, write commit messages, and push to your repository entirely through the UI.
If your projects extend beyond software into microcontrollers (Arduino, ESP32, STM32):
- Search for and install the PlatformIO IDE extension.
- Allow it to download its core dependencies and reload the window.
- Use the new "Alien" icon on your sidebar to create universal projects. PlatformIO replaces the standard Arduino IDE by handling toolchains, frameworks, and board configurations per project via a
platformio.inifile.
AI coding tools are transforming development by generating boilerplate, writing tests, and explaining complex logic. Add one of these top-tier AI assistants to your environment:
- GitHub Copilot: The industry standard. It acts as an advanced autocomplete, suggesting whole lines or entire functions as you type. (Requires a paid subscription or GitHub Student Developer Pack).
- Gemini Code Assist: Google's enterprise-grade AI assistant, offering robust code generation, chat capabilities, and deep integration for broader workflows.
- Claude Code for VS Code: Work with Claude directly in your codebase. Build, debug, and deploy from within your workspace.
- Cline: Excellent alternative if you are looking for free-tier capabilities or different AI models to test within your workspace. Cline can also be setup to handle complex software development tasks step-by-step.
Security Note: Always verify the publisher of any extension, especially AI tools and remote execution environments. Stick to verified publishers to avoid malicious marketplace extensions.
You are all set! Your VS Code is now a multi-purpose powerhouse ready for web dev, software engineering, AI-assisted coding, and hardware hacking.
- README.md - Documentation section index: all guides and cheat sheets in this directory
- arduinoIDE.md - Arduino IDE setup for ESP32/STM32; PlatformIO in VS Code is a modern alternative
- python.md - Python security scripting that VS Code's Python extension and AI assistants will help develop
- LinuxCheatSheet.md - Linux commands for running and managing the tools built in VS Code
๐ Source: Documentation/vscode.md | โ๏ธ Suggest an edit | โฌ
๏ธ Back to Technical Guides & Cheat Sheets
- ๐บ๏ธ Browse by Topic
- ๐ All Repository Files
- ๐งญ Learning Paths
- ๐ Master Guide
- ๐ค Glossary
- โ๏ธ Legal & Disclaimer
๐ Foundations & Learning
๐ก๏ธ Defense & Investigations
- Incident Response
- Open Source Intelligence (OSINT)
- Reverse Engineering
- Operations Security (OPSEC)
- Compliance
โ๏ธ Platforms & Infrastructure
๐ก Hardware, Wireless & Field Projects
- PNWC Cyberdeck
- Hardware Testing
- Hardware Hacking
- Software-Defined Radio
- Wardriving
- uConsole
- Space Security
๐งฐ Assessment & Field Reference
๐ฆ Downloads & Project Resources
๐๏ธ Additional Topics