Skip to content

Commit 6ffd9f4

Browse files
committed
feat(docs): update environment variable file references from '.shireEnv.json' to '.autodevEnv.json'
1 parent fcfe695 commit 6ffd9f4

File tree

3 files changed

+7
-12
lines changed

3 files changed

+7
-12
lines changed

docs/local-agent/shire-custom-variable.md

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,7 @@ onStreamingEnd: { parseCode | patch($filePath, $output) }
141141
|-----------|------------------|-----------------------------------------------------------------------------|---------------------------------------------|
142142
| find | 基于文本搜索 | `text`: 要搜索的文本 | `find("error")` |
143143
| grep | 使用模式进行搜索 | `patterns`: 要搜索的模式 | `grep("[a-zA-Z]+Controller")` |
144-
| sed | 查找和替换操作 | `pattern`: 要查找的模式<br />`replacements`: 替换的字符串<br />`isRegex`: 是否为正则表达式 | `sed("s/old/new/g")` |
144+
| sed | 查找和替换操作 | `pattern`: 要查找的模式<br />`replacements`: 替换的字符串<br />`isRegex`: 是否为正则表达式 | `sed("s/old/new/g")` |
145145
| sort | 排序操作 | `arguments`: 排序所需的参数 | `sort` |
146146
| uniq | 去除重复行 | `texts`: 要处理的文本 | `uniq("line1", "line2", "line1")` |
147147
| head | 获取文件的前几行 | `number`: 要获取的行数 | `head(10)` |
@@ -150,11 +150,6 @@ onStreamingEnd: { parseCode | patch($filePath, $output) }
150150
| print | 打印文本 | `texts`: 要打印的文本 | `print("Hello", "World")` |
151151
| cat | 连接文件 | `paths`: 要连接的文件路径 | `cat("file1.txt", "file2.txt")` |
152152
| notify | 使用 IDE 通知 | `message`: 要显示的通知消息 | `notify("Process completed successfully.")` |
153-
| splitting | 分割文本或文件 | `paths`: 要分割的文本或文件路径 | `splitting("file.txt", "file2.txt")` |
154-
| embedding | 嵌入文本 | `entries`: 要嵌入的文本条目 | `embedding("entry1", "entry2")` |
155-
| searching | 搜索文本 | `text`: 要搜索的文本, threshold: 置信度阈值(string, 默认 0.5) | `searching("pattern")` |
156-
| reranking | 重新排序 | `type`: 重排类型,默认 lostInTheMiddle | `reranking("pattern")` |
157-
| caching | 缓存语义 | `text`: 要缓存的文本 | `caching("data")` |
158153
| redact | 屏蔽敏感数据 | | `redact()` |
159154
| jsonpath | 使用 JsonPath 选择数据 | `jsonPath`: JsonPath 表达式,其中 jsonString 为可选 | `jsonpath(jsonString, "$.store.*")` |
160155
| batch | 批处理操作 | `fileName`: Shire 文件名,: paths`: 要处理的文件路径 | `batch("file1.shire", "file2.txt")` |

docs/local-agent/shire-env.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,17 +5,17 @@ parent: Shire Language
55
nav_order: 10
66
---
77

8-
Shire Environment 用于定义 Shire 的环境变量,用于存储一些敏感信息。 使用方式 `.shireEnv.json` 文件来存储环境变量,Shire
8+
Shire Environment 用于定义 Shire 的环境变量,用于存储一些敏感信息。 使用方式 `.autodevEnv.json` 文件来存储环境变量,Shire
99
将会自动加载这种文件。
1010

1111
当前 Shire Env 支持两种变量:
1212

1313
- `development`:配置 Token、API Key 等信息。
1414
- `models`:配置模型信息(在 `0.7.4` 版本后支持)。
1515

16-
## `.shireEnv.json` 文件
16+
## `.autodevEnv.json` 文件
1717

18-
`.shireEnv.json` 用于存储环境变量,Shire 将会自动加载这种文件,当前只支持 `development` 环境。
18+
`.autodevEnv.json` 用于存储环境变量,Shire 将会自动加载这种文件,当前只支持 `development` 环境。
1919

2020
```json
2121
{

docs/local-agent/shire-hobbit-hole.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ actionLocation: ContextMenu
3232
- `afterStreaming`:流结束后执行任务的决策,路由到不同的任务。
3333
- `shortcut`:操作的 IDE 快捷键,使用 IntelliJ IDEA 的快捷键格式。
3434
- `enabled`:是否启用操作。
35-
- `model`: 使用的大语言模型,使用 `.shireEnv.json` 定义。
35+
- `model`: 使用的大语言模型,使用 `.autodevEnv.json` 定义。
3636
- `userData`:其余数据。
3737

3838
### 示例代码
@@ -63,6 +63,7 @@ enum class InteractionType(val description: String) {
6363
ReplaceCurrentFile("Replace the content of the current file"),
6464
InsertBeforeSelection("Insert content before the currently selected content"),
6565
RunPanel("Show Result in Run panel which is the bottom of the IDE"),
66+
ChatPanel("Show Result in Chat panel which is the right of the IDE"),
6667
OnPaste("Copy the content to the clipboard"),
6768
RightPanel("Show Result in Right panel which is the right of the IDE"),
6869
StreamDiff("Use streaming diff to show the result")
@@ -85,10 +86,9 @@ enum class ShireActionLocation(val location: String, val description: String) {
8586
DATABASE_MENU("DatabaseMenu", "Show in Database panel menu bar"),
8687
CONSOLE_MENU("ConsoleMenu", "Show in Console panel menu bar"),
8788
VCS_LOG_MENU("VcsLogMenu", "Show in VCS Log panel menu bar"),
88-
CHAT_BOX("ChatBox", "Show in Chat Box"), // 将默认使用 RigthPanel 作为展示位置
89+
CHAT_BOX("ChatBox", "Show in Chat Box, default in Right Panel"),
8990
INLINE_CHAT("InlineChat", "Show in Inline Chat"),
9091

91-
/// external plugins
9292
EXT_SONARQUBE_MENU("ExtSonarQubeMenu", "Show in SonarQube panel menu bar"),
9393
;
9494
}

0 commit comments

Comments
 (0)