# VS Code ## Overview The **AquilaX AppSec VS Code Extension** brings **application security directly into your development environment**, allowing developers to identify and fix vulnerabilities early in the **Software Development Life Cycle (SDLC)**. With this extension, security findings are highlighted directly in your source code - helping you write safer code, faster. {% embed url="" %} *** ## 🚀 Key Features * **Real-Time Vulnerability Detection** - Security issues are highlighted inline as you code. * **Integration with AquilaX Scans** - Automatically syncs findings from AquilaX platform scans and maps them to exact file locations. * **Detailed Insights** - View severity, description, and recommended fixes directly within VS Code. * **Simple Setup** - Install and connect with your AquilaX account in just a few minutes. *** ## ⚙️ Prerequisites Before installing, make sure you have: * **VS Code** version `1.70.0` or later * An **active AquilaX account** * Access to at least one configured **organization** within AquilaX *** ## 🧩 Installation Guide ### Option 1 - Install via VS Code Marketplace 1. Open **Visual Studio Code**. 2. Go to the **Extensions** view (`Ctrl+Shift+X` or `Cmd+Shift+X` on macOS). 3. Search for **AquilaX AppSec**. 4. Click **Install** on the extension published by **AquilaX Ltd**. 5. Reload VS Code when prompted. ![Screenshot: Extension Search](https://53914109-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FjAmSnvnfbHl4EDK56iDo%2Fuploads%2Fgit-blob-037d412447276b93c7e2cf0b7adc8f30429cb47f%2Fextension_search.png?alt=media) *** ### Option 2 - Direct Marketplace Link Visit:\ 👉 [AquilaX AppSec Extension](https://marketplace.visualstudio.com/items?itemName=Aquilax.aquilax-appsec) Then click **Install** to add it to VS Code. ![Screenshot: Marketplace Install](https://53914109-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FjAmSnvnfbHl4EDK56iDo%2Fuploads%2Fgit-blob-0e5c1dcd5d38299da55c4ae2cc96c16f3b61ffc6%2Fmarketplace_install.png?alt=media) *** ## 🪄 Getting Started ### Step 1 - Login 1. After installation, open the **AquilaX AppSec** icon from the VS Code sidebar. 2. Click **Sign In** to authenticate using your AquilaX credentials. 3. Follow the browser-based authentication flow. ![Screenshot: Login Screen](https://53914109-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FjAmSnvnfbHl4EDK56iDo%2Fuploads%2Fgit-blob-e7288a6fc9254fd574e7497b178ee5221709f364%2Flogin_screen.png?alt=media) *** ### Step 2 - Select Organization * If your account is linked to multiple organizations, you’ll be prompted to select one. * Click **Select Organization** and choose the relevant organization. ![Screenshot: Organization Selection](https://53914109-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FjAmSnvnfbHl4EDK56iDo%2Fuploads%2Fgit-blob-a78650d69fd1bb2c1d7207289883c79b416cd8fe%2Fselect_org.png?alt=media) *** ### Step 3 - Open Your Project 1. Open your local project or repository in VS Code. 2. The extension automatically syncs your recent AquilaX scans. 3. Detected vulnerabilities appear as **highlighted annotations** in your code. ![Screenshot: Vulnerability Highlight](https://53914109-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FjAmSnvnfbHl4EDK56iDo%2Fuploads%2Fgit-blob-7f4d4b16f90544cc3733218477c0b7df8cb86560%2Fvulnerability_highlight.png?alt=media) *** ### Step 4 - View Details Hover over a highlighted line to view detailed vulnerability information, including: * Vulnerability name * Severity level * Description * Recommended remediation steps ![Screenshot: Vulnerability Tooltip](https://53914109-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FjAmSnvnfbHl4EDK56iDo%2Fuploads%2Fgit-blob-102b86f630a042195cb5dff61dafde8f112d4009%2Fvulnerability_tooltip.png?alt=media) *** ### Step 5 - Manage Sessions * To **switch organizations**, click **Change Organization**. * To **logout**, select **Logout** from the sidebar menu. ![Screenshot: Session Options](https://53914109-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FjAmSnvnfbHl4EDK56iDo%2Fuploads%2Fgit-blob-144e2d723d0aa6c79ad59dd350b36cf3566133ce%2Fsession_options.png?alt=media) *** ## 🧠 Troubleshooting ### Findings Not Displayed * Ensure your project has been scanned by AquilaX. * Verify you’re logged in and connected to the correct organization. * Check your internet connection. ### Authentication Issues * Re-login via the **Login** button in the extension sidebar. * Verify your AquilaX credentials and account status. ### Organization Not Found * Make sure your AquilaX account has organization access. * Contact your admin if the organization list is empty. *** ## ❓ FAQs **Q: Do I need to trigger scans manually?**\ A: No, the extension automatically fetches the latest scan results from AquilaX. **Q: Can I use it offline?**\ A: No, the extension requires internet access to sync scan data. **Q: Does it support all file types?**\ A: Yes, it supports all languages and frameworks covered by AquilaX AppSec. *** ## 💬 Support For issues, feedback, or feature requests, please contact us: 📧 **Email:** \ 💡 **Feedback Portal:** *** ## ❤️ Acknowledgments Built with ❤️ by **AquilaX Ltd** - your trusted partner in **Application Security Automation**. Powered by [AquilaX AppSec](https://aquilax.ai). --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.aquilax.ai/user-manual/devtools/ide/vs-code.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.