Back to Home

CodeShield Guide & Help Center

Discover features, learn step-by-step how-tos, and troubleshoot common questions.

User Guide
v1.3 Support
Quick Sign In with Demo Account
Step-by-step instructions
  1. 1.Navigate to the login screen (/login).
  2. 2.Locate the blue 'Demo Account' box below the password field.
  3. 3.Click 'Auto-fill' to automatically load the demo credentials (Username: admin / Password: password123).
  4. 4.Click 'Sign In' to bypass manually creating an admin account and instantly access the dashboard.
Tip: If the admin user does not exist or has a different password in your local database, the system will automatically seed/update the account details behind the scenes when you submit the demo login.
Auditing a Codebase / Project
Step-by-step instructions
  1. 1.Compress the target project directory into a standard .zip archive.
  2. 2.Log in to CodeShield and navigate to the 'Scan Upload' page.
  3. 3.Drag & drop your project ZIP file or select it from your local filesystem.
  4. 4.Choose your desired AI reasoning configuration (e.g. Model selection and providers).
  5. 5.Click 'Start Scan' and monitor execution progress in real-time.
Tip: Try scanning with one of the pre-included zip files (like test-project-with-vulns0.zip) in the root of the project to test the system out immediately!
Reviewing Scan Findings
Step-by-step instructions
  1. 1.Once the scan finishes, you will be redirected to the Scan Report Dashboard.
  2. 2.Look at the interactive charts highlighting severity counts (Critical, High, Medium, Low).
  3. 3.Scroll down to see the list of individual findings.
  4. 4.Click on a finding row to view detailed code snippets, line numbers, CWE details, risks, and recommended remediations.
Tip: Our static analysis engine includes built-in protection against ReDoS (Regular Expression Denial of Service) by using strictly bounded search patterns.
AI Auto-Remediation
Step-by-step instructions
  1. 1.Open a scan report and select a specific vulnerability finding.
  2. 2.Look for the 'Remediate with AI' action button in the details panel.
  3. 3.Click it to prompt the local or configured LLM to generate an optimized code fix.
  4. 4.Compare the generated code block or unified diff with your original implementation.
  5. 5.Click the copy button and paste the resolution directly into your local codebase.
Tip: AI enrichment works best when connecting to smart coding models like DeepSeek-Coder or Claude 3.5 Sonnet.