Skip to main content

relay_knowledge/project/
mod.rs

1//! Project identity shared by public API responses and adapters.
2
3/// Canonical package and product name used in user-facing output.
4pub const PROJECT_NAME: &str = "relay-knowledge";
5
6/// Canonical application directory name used in platform runtime paths.
7pub const APP_DIR_NAME: &str = PROJECT_NAME;
8
9/// Default SQLite database filename stored under the resolved data directory.
10pub const DATABASE_FILE_NAME: &str = "relay-knowledge.sqlite";
11
12/// Directory under the data directory that stores pluggable storage backends.
13pub const STORAGE_BACKENDS_DIR_NAME: &str = "stores";
14
15/// Directory under the storage backends directory that stores repository shards.
16pub const REPOSITORY_SHARDS_DIR_NAME: &str = "repositories";
17
18/// SQLite filename used by each partitioned repository shard.
19pub const REPOSITORY_SHARD_DATABASE_FILE_NAME: &str = "code.sqlite";
20
21/// Model provider profile configuration filename stored under the config directory.
22pub const MODEL_PROFILES_FILE_NAME: &str = "model-profiles.json";
23
24/// Model provider fallback policy filename stored under the config directory.
25pub const MODEL_FALLBACK_FILE_NAME: &str = "model-fallback.json";
26
27/// Model catalog cache filename stored under the cache directory.
28pub const MODEL_CATALOG_CACHE_FILE_NAME: &str = "model-catalog-cache.json";
29
30/// Repository-relative directory that stores shared agent contracts.
31pub const AGENT_CONTRACT_DIR_NAME: &str = "knowledge";
32
33/// Legacy repository contract directory accepted by v3 migration readers.
34pub const LEGACY_AGENT_CONTRACT_DIR_NAME: &str = ".knowledge";
35
36/// Repository-relative CodeSpec governance directory.
37pub const CODESPEC_DIR_NAME: &str = "codespec";
38
39/// Repository-relative knowledge navigation contract filename.
40pub const KNOWLEDGE_MAP_FILE_NAME: &str = "knowledge-map.yaml";
41
42/// Repository-relative knowledge navigation contract path referenced by agents.
43pub const KNOWLEDGE_MAP_RELATIVE_PATH: &str = "knowledge/knowledge-map.yaml";
44
45/// Legacy Knowledge Map root used by v1/v2 readers and v3 redirects.
46pub const LEGACY_KNOWLEDGE_MAP_RELATIVE_PATH: &str = ".knowledge/knowledge-map.yaml";
47
48/// Repository-relative CodeSpec navigation contract filename.
49pub const CODESPEC_MAP_FILE_NAME: &str = "codespec-map.yaml";
50
51/// Repository-relative CodeSpec navigation contract path.
52pub const CODESPEC_MAP_RELATIVE_PATH: &str = "codespec/codespec-map.yaml";
53
54/// Repository-relative authored business glossary filename.
55pub const BUSINESS_GLOSSARY_FILE_NAME: &str = "business-glossary.yaml";
56
57/// Repository-relative authored business glossary path.
58pub const BUSINESS_GLOSSARY_RELATIVE_PATH: &str = crate::domain::BUSINESS_GLOSSARY_RELATIVE_PATH;
59
60/// Legacy authored glossary path accepted during v3 migration.
61pub const LEGACY_BUSINESS_GLOSSARY_RELATIVE_PATH: &str =
62    crate::domain::LEGACY_BUSINESS_GLOSSARY_RELATIVE_PATH;
63
64/// Repository-local directory containing Knowledge Map v2 topic shards.
65pub const KNOWLEDGE_MAP_TOPICS_DIR_NAME: &str = "topics";
66
67/// Repository-relative prefix containing Knowledge Map v2 topic shards.
68pub const KNOWLEDGE_MAP_TOPICS_RELATIVE_PREFIX: &str = "knowledge/topics/";
69
70/// Repository-local directory containing immutable Knowledge Map history archives.
71pub const KNOWLEDGE_MAP_HISTORY_DIR_NAME: &str = "history";
72
73/// Version-check cache filename stored under the cache directory.
74pub const VERSION_CHECK_CACHE_FILE_NAME: &str = "version-check-cache.json";
75
76/// Default GitHub repository queried for release metadata.
77pub const GITHUB_REPOSITORY_FULL_NAME: &str = "coolplayagent/relay-knowledge";
78
79/// Windows service definition filename for installed background operation.
80pub const WINDOWS_SERVICE_DEFINITION_FILE_NAME: &str = "relay-knowledge-service.xml";
81
82/// macOS launchd service definition filename for installed background operation.
83pub const MACOS_SERVICE_DEFINITION_FILE_NAME: &str = "com.coolplayagent.relay-knowledge.plist";
84
85/// Linux systemd service definition filename for installed background operation.
86pub const LINUX_SERVICE_DEFINITION_FILE_NAME: &str = "relay-knowledge.service";
87
88/// Lifecycle checkpoint filename stored beside generated service definitions.
89pub const SERVICE_LIFECYCLE_CHECKPOINT_FILE_NAME: &str = "relay-knowledge-service-lifecycle.json";
90
91/// Resident MCP adapter identity reported in unified API metadata.
92pub const MCP_ADAPTER_NAME: &str = "relay-knowledge-mcp";
93
94/// Local ACP adapter identity reported in unified API metadata.
95pub const ACP_LOCAL_ADAPTER_NAME: &str = "relay-knowledge-acp-local";