docs: Add interactive CodeCanvas diagram for cli

[Abdulnaser97]

I provided answers to the PR template in the comments

🎨 Interactive Architecture Diagram for cli

This PR adds an interactive CodeCanvas diagram to help developers quickly understand the cli codebase.

What is CodeCanvas?

CodeCanvas transforms your repository into an interactive visual diagram that helps developers:

• 🗺️ Navigate complex codebases visually
• 🔍 Understand architecture and relationships at a glance
• 🚀 Onboard new team members faster
• 📝 Document your code structure automatically

📎 Try it now!

Preview the live diagram before merging: Open Interactive Diagram →

⚠️ Heads-up about the README link

The README link added in this PR points to the diagram in the default branch. It will start working once the PR is merged.

Preview while reviewing: Interactive Diagram

What this PR adds:

• ✅ Interactive diagram link in your README
• 📸 Visual preview of your codebase structure
• 🔗 Direct link for team members to explore cli visually

Simulation refinement tips

You might find that the simulations created in the diagram are incomplete or too elaborative - hit the "Refine Simulation" button. Read the 1 pager guide to learn how to refine simulations to create accurate diagrams.

---

Need Help?

💬 Join our Discord community: discord.gg/t3ezMyMPqr

After merging, anyone visiting your repository will be able to explore cli interactively through CodeCanvas.

code-canvas.com

[CLAassistant]

All committers have signed the CLA.

[snyk-io]

🎉 Snyk checks have passed. No issues have been found so far.

✅ security/snyk check is complete. No issues have been found. (View Details)

✅ license/snyk check is complete. No issues have been found. (View Details)

✅ code/snyk check is complete. No issues have been found. (View Details)

[Abdulnaser97]

Pull Request Submission Checklist

• Follows CONTRIBUTING guidelines
• Commit messages
  are release-note ready, emphasizing
  what was changed, not how.
• Includes detailed description of changes
• Contains risk assessment (Low | Medium | High)
• Highlights breaking API changes (if applicable)
• Links to automated tests covering new functionality
• Includes manual testing instructions (if necessary)
• Updates relevant GitBook documentation (PR link: ___)
• Includes product update to be announced in the next stable release notes

What does this PR do?

Introduces a diagram that explains how Snyk CLI works under the hood

Where should the reviewer start?

The diagram link below

How should this be manually tested?

Just go through one of the simulations on the diagram

What's the product update that needs to be communicated to CLI users?

There is now a diagram that explains how Snyk CLI works under the hood, check it out now

[Abdulnaser97]

Hi, anyone had the chance to review my PR?

[NsdHSO]

Hi @Abdulnaser97 Could you please change your title PR , to be like what is wrote in this document ?
https://www.conventionalcommits.org/en/v1.0.0/

[github-actions]

Your PR has not had any activity for 30 days. In 2 days I'll close it. Make some activity to remove this.

[Abdulnaser97]

Hi @Abdulnaser97 Could you please change your title PR , to be like what is wrote in this document ? https://www.conventionalcommits.org/en/v1.0.0/

Hi @NsdHSO, I added "docs:" at the beginning.
Is that everything?

[gitguardian]

⚠️ GitGuardian has uncovered 2 secrets following the scan of your pull request.

Please consider investigating the findings and remediating the incidents. Failure to do so may lead to compromising the associated services or software components.

Since your pull request originates from a forked repository, GitGuardian is not able to associate the secrets uncovered with secret incidents on your GitGuardian dashboard.
Skipping this check run and merging your pull request will create secret incidents on your GitGuardian dashboard.

🔎 Detected hardcoded secrets in your pull request

GitGuardian id	GitGuardian status	Secret	Commit	Filename
-	-	Bearer Token	11869c8	cli.CodeCanvas	View secret
-	-	Bearer Token	0833f07	cli.CodeCanvas	View secret

🛠 Guidelines to remediate hardcoded secrets

A potential secret has been detected in this pull request. Please take the following steps immediately:

1. Triage the Finding - Determine if the finding is a True Positive (a real secret) or a False Positive (e.g., test data, an example key).
   • For more triage information, click on the hyperlinked GitGuardian ID in the table above. You can also use these docs as a triage guide.
     • If this is a True Positive, proceed to step 2.
     • If it's a False Positive, follow the guide to handle false positives instead. If you're a team leader, click on the Remediation tab in GitGuardian to view the ignore approval request.

Not your repo? Get access to the GitGuardian issue by following these steps.

2. Start an Incident

   • If this is a True Positive, immediately declare a security incident. Do not merge this pull request.
     1. In Slack, type /fh and press Enter.
     2. Click the "🔥Open Incident" button.
     3. Select "Security Incident" from the "Incident Type" dropdown menu.

3. Follow the Runbook

   • The complete response procedure is documented in the runbook.

Have questions? Contact your ProdSec partner or post in #ask-prodsec.

---

^{🦉 GitGuardian detects secrets in your source code to help developers and security teams secure the modern development process. You are seeing this because you or someone else with access to this repository has authorized GitGuardian to scan your pull request.}