Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Minor docs updates for sample prompts #38

Merged
merged 1 commit into from
Jan 15, 2025
Merged

Minor docs updates for sample prompts #38

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/how-to/use-with-aider.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ To configure Aider to send requests through CodeGate:

To verify that you've successfully connected Aider to CodeGate, type
`/ask codegate-version` into the Aider chat in your terminal. You should receive
a response like "CodeGate version 0.1.0":
a response like "CodeGate version 0.1.7":

## Next steps

Expand Down
18 changes: 8 additions & 10 deletions docs/how-to/use-with-continue.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -380,10 +380,10 @@ Otherwise, remove the `apiKey` parameter from both sections.

To verify that you've successfully connected Continue to CodeGate, open the
Continue chat and type `codegate-version`. You should receive a response like
"CodeGate version 0.1.0":
"CodeGate version 0.1.7":

<ThemedImage
alt='Continue extension settings'
alt='Verify Continue integration'
sources={{
light: useBaseUrl('/img/how-to/continue-codegate-version-light.webp'),
dark: useBaseUrl('/img/how-to/continue-codegate-version-dark.webp'),
Expand All @@ -401,17 +401,15 @@ CodeGate responds with a warning and a link to the Stacklok Insight report about
this package:

```plain title="Continue chat"
Warning: CodeGate detected one or more malicious or archived packages.
Warning: CodeGate detected one or more malicious, deprecated or archived packages.

Package: https://insight.stacklok.com/pypi/invokehttp
• invokehttp: https://www.insight.stacklok.com/report/pypi/invokehttp

CodeGate Security Analysis
The `invokehttp` package from PyPI has been identified as malicious and should
not be used. Please avoid using this package and consider using a trusted
alternative such as `requests` for making HTTP requests in Python.

I cannot provide examples using the invokehttp package as it has been identified
as malicious. Using this package could compromise your system's security.

Instead, I recommend using well-established, secure alternatives for HTTP
requests in Python:
Here is an example of how to use the `requests` package:

...
```
Expand Down
27 changes: 9 additions & 18 deletions docs/how-to/use-with-copilot.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -233,16 +233,9 @@ Support for JetBrains is [coming soon](https://github.com/stacklok/codegate/issu

## Verify configuration

To verify that CodeGate is receiving Copilot traffic as expected, open the
Copilot chat and type `What do you know about CodeGate?`. You should receive a
response that starts like this:

```plain title="Copilot chat"
CodeGate is a security-focused AI assistant designed to help with software
security, package analysis, and providing guidance on secure coding practices.

...
```
To verify that you've successfully connected Copilot to CodeGate, open the
Copilot chat and type `codegate-version`. You should receive a response like
"CodeGate version 0.1.7".

Try asking CodeGate about a known malicious Python package:

Expand All @@ -254,17 +247,15 @@ CodeGate responds with a warning and a link to the Stacklok Insight report about
this package:

```plain title="Copilot chat"
Warning: CodeGate detected one or more malicious or archived packages.

Package: https://insight.stacklok.com/pypi/invokehttp
Warning: CodeGate detected one or more malicious, deprecated or archived packages.

CodeGate Security Analysis
• invokehttp: https://www.insight.stacklok.com/report/pypi/invokehttp

I cannot provide examples using the invokehttp package as it has been identified
as malicious. Using this package could compromise your system's security.
The `invokehttp` package from PyPI has been identified as malicious and should
not be used. Please avoid using this package and consider using a trusted
alternative such as `requests` for making HTTP requests in Python.

Instead, I recommend using well-established, secure alternatives for HTTP
requests in Python:
Here is an example of how to use the `requests` package:

...
```
Expand Down
3 changes: 3 additions & 0 deletions docs/quickstart-copilot.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,9 @@ Add the following settings to your configuration:
}
```

Enter `codegate-version` in the Copilot chat to confirm that CodeGate is
intercepting Copilot traffic. CodeGate responds with its version number.

## Explore CodeGate's key features

To learn more about CodeGate's capabilities, clone the demo repository to a
Expand Down
Loading