Skip to content
This repository was archived by the owner on Jun 5, 2025. It is now read-only.

Commit 0b11561

Browse files
Luke Hindsyrobla
andauthored
Rewrite the readme to make clear codegate is a developer tool (#1110)
* Rewrite the readme to make clear codegate is a developer tool * Fix title * Fix title * Readme tweaks --------- Co-authored-by: Yolanda Robla Mota <[email protected]>
1 parent 2cc647b commit 0b11561

File tree

7 files changed

+83
-17
lines changed

7 files changed

+83
-17
lines changed

README.md

Lines changed: 83 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -21,33 +21,54 @@
2121

2222
---
2323

24-
# CodeGate: secure AI code generation
24+
# CodeGate: AI Development environments simplified.
2525

26-
**By [Stacklok](https://stacklok.com)**
26+
**From [Stacklok](https://stacklok.com)**
2727

28-
CodeGate is a **local gateway** that makes AI agents and coding assistants safer. It
29-
ensures AI-generated recommendations adhere to best practices while safeguarding
30-
your code's integrity and protecting your privacy. With CodeGate, you can
31-
confidently leverage AI in your development workflow without sacrificing
32-
security or productivity.
28+
CodeGate is the ultimate toolkit for developers using coding assistants to build AI applications. It streamlines multi-environment workflows, enabling you to consume AI with confidence from development to production. It empowers ongoing AI application management by optimizing model routing, prompt tracking and security enforcement, ensuring privacy, compliance, and robust operational integrity.
29+
30+
---
31+
32+
## CodeGate Architecture
3333

3434
<picture>
3535
<source media="(prefers-color-scheme: dark)" srcset="./static/diagram-dark.png">
3636
<img alt="CodeGate dashboard" src="./static/diagram-light.png" width="1100px" style="max-width: 100%;">
3737
</picture>
3838

39-
---
40-
## ✨ Why choose CodeGate?
4139

42-
AI coding assistants are powerful, but they can inadvertently introduce risks.
43-
CodeGate protects your development process by:
40+
## 🚀 Why Developers Love CodeGate
41+
42+
AI unlocks new levels of productivity, but you need to use consume
43+
with confidence. CodeGate helps you do just that, by providing a suite of
44+
features that make AI development safe and efficient.
45+
46+
### Key Features
47+
48+
- **Workspaces**: Organize and personalize your AI tooling and environments.
49+
- **Prompt & Alert History**: Track AI suggestions and security insights in one place.
50+
- **Model Muxing**: Switch seamlessly between AI models per project or route
51+
specfic file types to a particular model or provider.
52+
- **Custom Instructions**: Tailor your AI’s behavior to match your coding style,
53+
by providing custom prompts or instructions per project or workspace.
54+
- **Prompt Database**: Leverage a growing collection of developer-contributed
55+
prompts or create and store your own, to make them available across all your
56+
projects and workspaces.
57+
58+
🔒 Built-in Security, Zero Effort
4459

45-
- 🔒 Preventing accidental exposure of secrets and sensitive data
46-
- 🛡️ Ensuring AI suggestions follow secure coding practices
47-
- ⚠️ Blocking recommendations of known malicious or deprecated libraries
48-
- 🔍 Providing real-time security analysis of AI suggestions
60+
- **Secrets Protection**: Prevent sensitive data from leaking to AI cloud
61+
service providers.
62+
- **Malicious Package Detection**: Block risky dependencies before they reach
63+
your code, using Stackloks free AI / ML inteligence threat detection pipeline.
64+
- **Command Execution Monitoring**: Stop AI-generated shell commands from running
65+
unsafe actions within your agent or coding assistant.
66+
- **PII Protection**: Prevent personally identifiable information from being
67+
exposed to AI cloud service providers, such as credit card numbers,
68+
social security numbers, and more.
4969

5070
---
71+
5172
## 🚀 Quickstart
5273

5374
### Prerequisites
@@ -85,8 +106,11 @@ documentation.
85106

86107
CodeGate includes a web dashboard that provides:
87108

88-
- A view of **security risks** detected by CodeGate
89-
- A **history of interactions** between your AI coding assistant and your LLM
109+
- **Manage workspaces** and AI model / provider routing rules.
110+
- **Track security risks** detected by CodeGate.
111+
- **Manage project prompts** and apply them across all your projects and
112+
workspaces.
113+
- **History of interactions** between your AI coding assistant and your LLM.
90114

91115
<picture>
92116
<source media="(prefers-color-scheme: dark)" srcset="./static/dashboard-dark.webp">
@@ -104,6 +128,48 @@ To learn more, visit the
104128
---
105129
## 🔐 Features
106130

131+
### Workspaces
132+
133+
<picture>
134+
<source media="(prefers-color-scheme: dark)" srcset="./static/workspace-light.png">
135+
<img alt="CodeGate logo" src="./static/workspace-dark.png" width="800px" style="max-width: 100%;">
136+
</picture>
137+
138+
Workspaces are a way to organize your AI tooling and environments. You can
139+
create multiple workspaces to switch between them as needed.
140+
141+
Workspaces can be used to:
142+
143+
- Switch between different AI models or providers.
144+
- Apply different prompts or instructions to different projects.
145+
- Isolate projects by applying different settings or rules.
146+
147+
Workspaces are then available within all the different AI coding assistants
148+
and tools that CodeGate supports (i.e. Aider, Cline, Continue, Copilot, Open-Interpreter, etc.)
149+
150+
### Prompt Database
151+
152+
<picture>
153+
<source media="(prefers-color-scheme: dark)" srcset="./static/prompts-light.png">
154+
<img alt="CodeGate logo" src="./static/prompts-dark.png" width="800px" style="max-width: 100%;">
155+
</picture>
156+
157+
The Prompt Database is a collection of prompts that you can use across all your
158+
projects and workspaces. You can also contribute your own prompts to the
159+
database.
160+
161+
### Model Muxing
162+
163+
<picture>
164+
<source media="(prefers-color-scheme: dark)" srcset="./static/mux-light.png">
165+
<img alt="CodeGate logo" src="./static/mux-dark.png" width="800px" style="max-width: 100%;">
166+
</picture>
167+
168+
169+
Model Muxing is a feature that allows you to route different workspaces or
170+
to different AI models or providers, even down the level of a single file.
171+
172+
107173
### Secrets encryption
108174

109175
CodeGate helps you protect sensitive information from being accidentally exposed

static/mux-dark.png

209 KB
Loading

static/mux-light.png

223 KB
Loading

static/prompts-dark.png

607 KB
Loading

static/prompts-light.png

657 KB
Loading

static/workspace-dark.png

206 KB
Loading

static/workspace-light.png

201 KB
Loading

0 commit comments

Comments
 (0)