kubescape/docs

Kubescape Documentation

Welcome to the Kubescape documentation. This directory contains detailed guides and references for using Kubescape.

📚 Documentation Index

Getting Started

Document	Description
Installation Guide	How to install Kubescape on various platforms
Getting Started	First steps with Kubescape, basic usage examples

Reference

Document	Description
CLI Reference	Complete command-line reference for all Kubescape commands
Architecture	Technical architecture of Kubescape CLI and Operator

Features

Document	Description
MCP Server	AI assistant integration via Model Context Protocol
Providers	Backend services compatible with Kubescape

Support

Document	Description
Troubleshooting	Common issues and solutions

Additional Resources

Document	Description
Environment Dependencies Policy	Policy on external dependencies
Roadmap	Project roadmap (see centralized governance repo)

📁 Subdirectories

Directory	Description
img/	Images and diagrams used in documentation
proposals/	Design proposals and RFCs
providers/	Provider-specific documentation

🔗 External Documentation

• Kubescape Website - Official website with additional guides
• Kubescape Docs Hub - Comprehensive online documentation
• Controls Reference - List of all security controls
• Helm Charts - Operator installation
• Regolibrary - Security controls library

🤝 Contributing to Documentation

We welcome contributions to improve our documentation! Please see the Contributing Guide for details.

Documentation Style

• Use clear, concise language
• Include code examples where applicable
• Keep command examples copy-pasteable
• Update the table of contents when adding sections
• Test all commands before documenting them

📝 Document Status

Document	Status	Description
installation.md	✅ Current	Installation methods for all platforms
getting-started.md	✅ Current	Quick start and usage examples
cli-reference.md	✅ Current	Complete CLI command reference
architecture.md	✅ Current	Technical architecture documentation
mcp-server.md	✅ Current	AI assistant integration (MCP)
troubleshooting.md	✅ Current	Common issues and solutions
providers.md	✅ Current	Backend service providers
environment-dependencies-policy.md	✅ Current	Dependency policies

---

📖 Quick Links

I want to...	Go to...
Install Kubescape	Installation Guide
Run my first scan	Getting Started
See all CLI options	CLI Reference
Use Kubescape with AI assistants	MCP Server
Fix a problem	Troubleshooting
Understand the architecture	Architecture