Skip to content

Commit ad79c64

Browse files
authored
Readme requires update (#1158)
* Readme requires update The readme has falling behind and it not showcasing work such as workspaces and muxing, it also introduces that CodeGate is far more then just a security protection system. * Readme tweaks
1 parent 9a5d91a commit ad79c64

File tree

1 file changed

+44
-80
lines changed

1 file changed

+44
-80
lines changed

README.md

+44-80
Original file line numberDiff line numberDiff line change
@@ -21,54 +21,35 @@
2121

2222
---
2323

24-
# CodeGate: AI Development environments simplified.
24+
# CodeGate: Security, Workspaces and Muxing for AI Applications, coding assistants, and agentic frameworks.
2525

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

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.
28+
CodeGate is an agent designed to make AI applications, coding assistants and agentic frameworks, safer and easier to consume and manage. It provides a centralized, abstracted environment for managing prompts, model provider configurations, model muxing, and more. Additionally, CodeGate offers security analysis of AI-generated code, ensuring that recommendations follow best practices and safeguard your code's integrity.
2929

30-
---
31-
32-
## CodeGate Architecture
30+
With CodeGate, you can configure all your AI coding assistants and agents to use a single workspace
31+
and benefit from a unified view of all the interactions between your AI coding assistants and your
32+
models.
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?
3941

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
42+
AI coding assistants are powerful, but they can inadvertently introduce risks and configurations
43+
can sprawl across multiple IDE extensions, plugins and agent systems. CodeGate simplifies the management of AI model and provider configurations and provides additional features to help you keep your development process safe.
5944

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.
45+
- 🌐 Centralize and manage all your AI coding assistants in one place
46+
- 🔄 Mux / Route prompts to different AI models based on workspaces or file types
47+
- 🔑 Centrally configure and manage your provider credentials and API keys
48+
- 🛡️ Protect your development process from accidental exposure of secrets and sensitive personal data to the cloud
49+
- 🔒 Ensure that the recommendations provided by your AI coding assistants follow secure coding practices
50+
- 🚫 Prevent malicious or deprecated libraries from being recommended to you by an LLM
6951

7052
---
71-
7253
## 🚀 Quickstart
7354

7455
### Prerequisites
@@ -106,11 +87,8 @@ documentation.
10687

10788
CodeGate includes a web dashboard that provides:
10889

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.
90+
- A view of **security risks** detected by CodeGate
91+
- A **history of interactions** between your AI coding assistant and your LLM
11492

11593
<picture>
11694
<source media="(prefers-color-scheme: dark)" srcset="./static/dashboard-dark.webp">
@@ -128,55 +106,33 @@ To learn more, visit the
128106
---
129107
## 🔐 Features
130108

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>
109+
### Workspace management
156110

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.
111+
CodeGate allows you to create workspaces, each with its own set of AI
112+
models, configurations, prompts and chat history to help you manage your AI application
113+
and development environment more effectively. [Learn more](https://docs.codegate.ai/features/workspaces)
160114

161115
### Model Muxing
162116

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-
117+
CodeGate lets you route traffic between multiple AI models using a configurable
118+
model muxer. This feature is useful when you want to use different models for
119+
different purposes, such as code generation, summarization, documentation, etc.
120+
[Learn more](https://docs.codegate.ai/features/model-muxing)
168121

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-
173-
### Secrets encryption
122+
### Secrets Redaction
174123

175124
CodeGate helps you protect sensitive information from being accidentally exposed
176125
to AI models and third-party AI provider systems by redacting detected secrets
177-
from your prompts using encryption.
126+
from your prompts.
178127
[Learn more](https://docs.codegate.ai/features/secrets-encryption)
179128

129+
### Personal Identifiable Information (PII) detection and redaction
130+
131+
CodeGate helps you protect personal data from being accidentally exposed to AI
132+
models and third-party AI provider systems by redacting detected PII from your prompts.
133+
134+
Should CodeGate sense that a prompt contains PII, such as credit card numbers, social security numbers, or other sensitive information, it will automatically redact the PII from the prompt before sending it to the AI model, to then unredact the response before sending it back to the client.
135+
180136
### Dependency risk awareness
181137

182138
LLMs’ knowledge cutoff date is often months or even years in the past. They
@@ -231,6 +187,14 @@ or potential vulnerabilities to help you adopt more secure coding practices.
231187
- The Copilot plugin works with **Visual Studio Code (VS Code)** (JetBrains is
232188
coming soon!)
233189

190+
### OpenIntepreter
191+
192+
- **Local / self-managed:**
193+
- Ollama
194+
- **Hosted:**
195+
- Anthropic
196+
- OpenAI and compatible APIs
197+
234198
---
235199
## 🛡️ Privacy first
236200

@@ -284,4 +248,4 @@ Start by reading our
284248

285249
Made with [contrib.rocks](https://contrib.rocks).
286250

287-
<!-- markdownlint-disable-file first-line-heading no-inline-html -->
251+
<!-- markdownlint-disable-file first-line-heading no-inline-html -->

0 commit comments

Comments
 (0)