249 lines
5.5 KiB
Markdown
249 lines
5.5 KiB
Markdown
# 脚本文档
|
||
|
||
本文档自动生成，包含项目中所有脚本的说明。
|
||
|
||
## 脚本列表
|
||
|
||
### scripts/ci-cd/build/generate-docs.sh
|
||
|
||
**描述**: 文档生成脚本
|
||
自动生成项目文档
|
||
颜色定义
|
||
|
||
**用法**: 请查看脚本内部说明
|
||
|
||
### scripts/ci-cd/quality/lint.sh
|
||
|
||
**描述**: 代码质量检查脚本
|
||
检查脚本语法、代码风格等
|
||
颜色定义
|
||
|
||
|
||
### scripts/ci-cd/quality/security-scan.sh
|
||
|
||
**描述**: 安全扫描脚本
|
||
扫描代码中的安全问题和敏感信息
|
||
颜色定义
|
||
|
||
|
||
### scripts/deployment/consul/consul-variables-example.sh
|
||
|
||
**描述**: Consul 变量和存储配置示例脚本
|
||
此脚本展示了如何配置Consul的变量和存储功能
|
||
配置参数
|
||
|
||
|
||
### scripts/deployment/consul/deploy-consul-cluster-kv.sh
|
||
|
||
**描述**: Consul集群部署脚本 - 遵循最佳变量命名规范
|
||
此脚本将部署一个完全遵循 config/{environment}/{provider}/{region_or_service}/{key} 格式的Consul集群
|
||
配置参数
|
||
|
||
|
||
### scripts/deployment/vault/deploy-vault.sh
|
||
|
||
**描述**: 部署Vault集群的脚本
|
||
检查并安装Vault
|
||
|
||
|
||
### scripts/deployment/vault/vault-dev-example.sh
|
||
|
||
**描述**: Vault开发环境使用示例
|
||
设置环境变量
|
||
|
||
|
||
### scripts/deployment/vault/vault-dev-quickstart.sh
|
||
|
||
**描述**: Vault开发环境快速开始指南
|
||
1. 设置环境变量
|
||
|
||
|
||
### scripts/mcp/configs/sync-all-configs.sh
|
||
|
||
**描述**: 链接所有MCP配置文件的脚本
|
||
该脚本将所有IDE和AI助手的MCP配置链接到NFS共享的配置文件
|
||
检查NFS配置文件是否存在
|
||
|
||
|
||
### scripts/mcp/tools/start-mcp-server.sh
|
||
|
||
**描述**: 设置环境变量
|
||
启动MCP服务器
|
||
|
||
|
||
### scripts/setup/config/generate-consul-config.sh
|
||
|
||
**描述**: Consul配置生成脚本
|
||
此脚本使用Consul模板从KV存储生成最终的Consul配置文件
|
||
配置参数
|
||
|
||
|
||
### scripts/setup/config/setup-consul-cluster-variables.sh
|
||
|
||
**描述**: Consul变量配置脚本 - 遵循最佳命名规范
|
||
此脚本将Consul集群配置存储到Consul KV中，遵循 config/{environment}/{provider}/{region_or_service}/{key} 格式
|
||
配置参数
|
||
|
||
|
||
### scripts/setup/config/setup-consul-variables-and-storage.sh
|
||
|
||
**描述**: Consul 变量和存储配置脚本
|
||
用于增强Consul集群功能
|
||
颜色输出
|
||
|
||
|
||
### scripts/setup/environment/setup-environment.sh
|
||
|
||
**描述**: 环境设置脚本
|
||
用于设置开发环境的必要组件和依赖
|
||
颜色定义
|
||
|
||
|
||
### scripts/setup/init/init-vault-cluster.sh
|
||
|
||
**描述**: Vault集群初始化和解封脚本
|
||
颜色定义
|
||
|
||
|
||
### scripts/setup/init/init-vault-dev-api.sh
|
||
|
||
**描述**: 通过API初始化Vault开发环境（无需本地vault命令）
|
||
颜色定义
|
||
|
||
|
||
### scripts/setup/init/init-vault-dev.sh
|
||
|
||
**描述**: Vault开发环境初始化脚本
|
||
颜色定义
|
||
|
||
|
||
### scripts/testing/infrastructure/test-nomad-config.sh
|
||
|
||
**描述**: 测试Nomad配置文件
|
||
|
||
|
||
### scripts/testing/infrastructure/test-traefik-deployment.sh
|
||
|
||
**描述**: Traefik部署测试脚本
|
||
用于测试Traefik在Nomad集群中的部署和功能
|
||
颜色定义
|
||
|
||
**用法**: 请查看脚本内部说明
|
||
|
||
### scripts/testing/integration/verify-vault-consul-integration.sh
|
||
|
||
**描述**: 验证Vault与Consul集成状态
|
||
颜色定义
|
||
|
||
|
||
### scripts/testing/mcp/test_direct_search.sh
|
||
|
||
**描述**: 创建一个简单的Python脚本来测试search_documents方法
|
||
|
||
|
||
### scripts/testing/mcp/test_local_mcp_servers.sh
|
||
|
||
**描述**: 测试当前环境中的MCP服务器
|
||
检查当前环境中是否有MCP配置
|
||
|
||
|
||
### scripts/testing/mcp/test_mcp_interface.sh
|
||
|
||
**描述**: 测试MCP服务器在实际MCP接口中的调用
|
||
|
||
|
||
### scripts/testing/mcp/test_mcp_search_final.sh
|
||
|
||
**描述**: 先添加一个文档
|
||
|
||
|
||
### scripts/testing/mcp/test_mcp_servers.sh
|
||
|
||
**描述**: 测试MCP服务器脚本
|
||
|
||
|
||
### scripts/testing/mcp/test_qdrant_ollama_tools.sh
|
||
|
||
**描述**: 测试search_documents工具
|
||
|
||
|
||
### scripts/testing/mcp/test_qdrant_ollama_tools_fixed.sh
|
||
|
||
**描述**: 测试search_documents工具（不带filter参数）
|
||
|
||
|
||
### scripts/testing/mcp/test_search_documents.sh
|
||
|
||
**描述**: 先添加一个文档
|
||
|
||
|
||
### scripts/testing/run_all_tests.sh
|
||
|
||
**描述**: MCP服务器测试运行器
|
||
自动运行所有MCP服务器测试脚本
|
||
颜色定义
|
||
|
||
|
||
### scripts/testing/test-runner.sh
|
||
|
||
**描述**: 项目测试快速执行脚本
|
||
从项目根目录快速运行所有MCP服务器测试
|
||
颜色定义
|
||
|
||
|
||
### scripts/utilities/backup/backup-all.sh
|
||
|
||
**描述**: 全量备份脚本
|
||
备份所有重要的配置和数据
|
||
颜色定义
|
||
|
||
|
||
### scripts/utilities/backup/backup-consul.sh
|
||
|
||
**描述**: Consul备份脚本
|
||
此脚本用于创建Consul的快照备份，并管理备份文件
|
||
配置参数
|
||
|
||
|
||
### scripts/utilities/helpers/fix-alpine-cgroups-systemd.sh
|
||
|
||
**描述**: Alternative script to fix cgroup configuration using systemd approach
|
||
Check if running as root
|
||
|
||
|
||
### scripts/utilities/helpers/fix-alpine-cgroups.sh
|
||
|
||
**描述**: Script to fix cgroup configuration for container runtime in Alpine Linux
|
||
Check if running as root
|
||
|
||
|
||
### scripts/utilities/helpers/manage-vault-consul.sh
|
||
|
||
**描述**: Vault与Consul集成管理脚本
|
||
颜色定义
|
||
函数定义
|
||
|
||
**用法**: 请查看脚本内部说明
|
||
|
||
### scripts/utilities/helpers/nomad-leader-discovery.sh
|
||
|
||
**描述**: Nomad 集群领导者发现与访问脚本
|
||
此脚本自动发现当前 Nomad 集群领导者并执行相应命令
|
||
默认服务器列表（可根据实际情况修改）
|
||
|
||
**用法**: 请查看脚本内部说明
|
||
|
||
### scripts/utilities/helpers/show-vault-dev-keys.sh
|
||
|
||
**描述**: 显示开发环境Vault密钥信息
|
||
检查密钥文件是否存在
|
||
|
||
|
||
### scripts/utilities/maintenance/cleanup-global-config.sh
|
||
|
||
**描述**: Nomad Global 配置清理脚本
|
||
此脚本用于移除配置文件中的 .global 后缀
|
||
颜色输出
|
||
|
||
|