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.

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

(Agentic Chat) Deep Cody docs #841

Open
wants to merge 16 commits into
base: main
Choose a base branch
from
Open

(Agentic Chat) Deep Cody docs #841

wants to merge 16 commits into from

Conversation

MaedahBatool
Copy link
Collaborator

@MaedahBatool MaedahBatool commented Dec 10, 2024

Copy link

vercel bot commented Dec 10, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
sourcegraph-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 15, 2025 3:39pm

@MaedahBatool MaedahBatool self-assigned this Dec 10, 2024
@MaedahBatool MaedahBatool added documentation Improvements or additions to documentation enhancement New feature or request labels Dec 10, 2024
@MaedahBatool MaedahBatool changed the title Deep Cody docs (Agentic Chat) Deep Cody docs Jan 14, 2025

### Enable Agentic Chat access to CLI

Update the `cody.agentic.context` setting to `allow` or `block` specific commands:
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@graceshih-sg I need to double-check this section with you. Is it factually correct?

Copy link
Contributor

@abeatrix abeatrix left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

left some comments inline for the changes

docs/cody/capabilities/agentic-chat.mdx Outdated Show resolved Hide resolved
docs/cody/capabilities/agentic-chat.mdx Outdated Show resolved Hide resolved
docs/cody/capabilities/agentic-chat.mdx Outdated Show resolved Hide resolved
docs/cody/capabilities/agentic-chat.mdx Outdated Show resolved Hide resolved
docs/cody/capabilities/agentic-chat.mdx Outdated Show resolved Hide resolved
docs/cody/capabilities/agentic-chat.mdx Outdated Show resolved Hide resolved
docs/cody/capabilities/agentic-chat.mdx Outdated Show resolved Hide resolved

### Configure shell command execution

You can configure shell command execution via the `cody.agentic.context` setting in your editor:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
You can configure shell command execution via the `cody.agentic.context` setting in your editor:
You can configure terminal access in the chat UI, under the agentic context settings.
image

Comment on lines +69 to +87
#### Enable Agentic Chat access to CLI

Update the `cody.agentic.context` setting to `allow` or `block` specific commands:

```json
{
"cody.agentic.context": {
"shell": {
// Array of allowed command prefixes, or ["*"] for all commands
"allow": ["git", "gh", "ls"],
"block": ["git"] // Additional commands to block
}
}
}
```

#### Disable Agentic Chat access to CLI

To disable the feature, navigate to your user settings and set `cody.agentic.context` to an empty value. When disabled, the chat agent cannot access the CLI.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@MaedahBatool we have moved the settings out of the json file into the UI:

image
Suggested change
#### Enable Agentic Chat access to CLI
Update the `cody.agentic.context` setting to `allow` or `block` specific commands:
```json
{
"cody.agentic.context": {
"shell": {
// Array of allowed command prefixes, or ["*"] for all commands
"allow": ["git", "gh", "ls"],
"block": ["git"] // Additional commands to block
}
}
}
```
#### Disable Agentic Chat access to CLI
To disable the feature, navigate to your user settings and set `cody.agentic.context` to an empty value. When disabled, the chat agent cannot access the CLI.


### Security concerns

As mentioned above, Agentic Chat's ability to execute terminal commands enhances its context-gathering capabilities. However, it’s essential to understand that any information accessible via your terminal could be shared with the LLM.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should mention how they can disable this feature by setting agentic-chat-cli-tool-experimental to false

docs/cody/capabilities/agentic-chat.mdx Outdated Show resolved Hide resolved
docs/cody/capabilities/agentic-chat.mdx Show resolved Hide resolved
docs/cody/capabilities/agentic-chat.mdx Outdated Show resolved Hide resolved
docs/cody/capabilities/agentic-chat.mdx Outdated Show resolved Hide resolved
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants