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/// Retained v1/v2 Knowledge Map root used to preflight and execute v3 rollback.
49pub const LEGACY_KNOWLEDGE_MAP_BACKUP_FILE_NAME: &str = "knowledge-map.v2.yaml";
50
51/// Previous legacy Knowledge Map root retained by v1/v2 manifest publication.
52pub const LEGACY_KNOWLEDGE_MAP_PREVIOUS_FILE_NAME: &str = "knowledge-map.yaml.previous";
53
54/// Retained visible v3 Knowledge Map root kept after a rollback.
55pub const KNOWLEDGE_MAP_V3_RETAINED_FILE_NAME: &str = "knowledge-map.yaml.v3.previous";
56
57/// Retained ordinary publication backup kept outside the visible reader fallback after rollback.
58pub const KNOWLEDGE_MAP_V3_RETAINED_BACKUP_FILE_NAME: &str =
59    "knowledge-map.yaml.v3.previous.backup";
60
61/// Staged legacy redirect used by the recoverable v3 publication protocol.
62pub const LEGACY_KNOWLEDGE_MAP_REDIRECT_PREPARED_FILE_NAME: &str =
63    "knowledge-map.yaml.redirect.prepared";
64
65/// Previous legacy root used by the recoverable v3 redirect publication protocol.
66pub const LEGACY_KNOWLEDGE_MAP_REDIRECT_PREVIOUS_FILE_NAME: &str =
67    "knowledge-map.yaml.redirect.previous";
68
69/// Staged retained root used by the no-follow v3 rollback publication protocol.
70pub const LEGACY_KNOWLEDGE_MAP_ROLLBACK_PREPARED_FILE_NAME: &str =
71    "knowledge-map.yaml.rollback.prepared";
72
73/// Previous legacy live root used while atomically publishing a v3 rollback.
74pub const LEGACY_KNOWLEDGE_MAP_ROLLBACK_PREVIOUS_FILE_NAME: &str =
75    "knowledge-map.yaml.rollback.previous";
76
77/// Repository-relative CodeSpec navigation contract filename.
78pub const CODESPEC_MAP_FILE_NAME: &str = "codespec-map.yaml";
79
80/// Repository-relative CodeSpec navigation contract path.
81pub const CODESPEC_MAP_RELATIVE_PATH: &str = "codespec/codespec-map.yaml";
82
83/// Repository-relative authored business glossary filename.
84pub const BUSINESS_GLOSSARY_FILE_NAME: &str = "business-glossary.yaml";
85
86/// Repository-relative authored business glossary path.
87pub const BUSINESS_GLOSSARY_RELATIVE_PATH: &str = crate::domain::BUSINESS_GLOSSARY_RELATIVE_PATH;
88
89/// Legacy authored glossary path accepted during v3 migration.
90pub const LEGACY_BUSINESS_GLOSSARY_RELATIVE_PATH: &str =
91    crate::domain::LEGACY_BUSINESS_GLOSSARY_RELATIVE_PATH;
92
93/// Repository-local directory containing content-addressed Knowledge Map topic shards.
94pub const KNOWLEDGE_MAP_TOPICS_DIR_NAME: &str = "topics";
95
96/// Repository-relative prefix containing content-addressed Knowledge Map topic shards.
97pub const KNOWLEDGE_MAP_TOPICS_RELATIVE_PREFIX: &str = "knowledge/topics/";
98
99/// Legacy repository-local directory recognized only for bounded migration cleanup.
100pub const KNOWLEDGE_MAP_HISTORY_DIR_NAME: &str = "history";
101
102/// Version-check cache filename stored under the cache directory.
103pub const VERSION_CHECK_CACHE_FILE_NAME: &str = "version-check-cache.json";
104
105/// Default GitHub repository queried for release metadata.
106pub const GITHUB_REPOSITORY_FULL_NAME: &str = "coolplayagent/relay-knowledge";
107
108/// Windows service definition filename for installed background operation.
109pub const WINDOWS_SERVICE_DEFINITION_FILE_NAME: &str = "relay-knowledge-service.xml";
110
111/// macOS launchd service definition filename for installed background operation.
112pub const MACOS_SERVICE_DEFINITION_FILE_NAME: &str = "com.coolplayagent.relay-knowledge.plist";
113
114/// Linux systemd service definition filename for installed background operation.
115pub const LINUX_SERVICE_DEFINITION_FILE_NAME: &str = "relay-knowledge.service";
116
117/// Lifecycle checkpoint filename stored beside generated service definitions.
118pub const SERVICE_LIFECYCLE_CHECKPOINT_FILE_NAME: &str = "relay-knowledge-service-lifecycle.json";
119
120/// Resident MCP adapter identity reported in unified API metadata.
121pub const MCP_ADAPTER_NAME: &str = "relay-knowledge-mcp";
122
123/// Local ACP adapter identity reported in unified API metadata.
124pub const ACP_LOCAL_ADAPTER_NAME: &str = "relay-knowledge-acp-local";
relay_knowledge/project/mod.rs

relay_knowledge/project/
mod.rs
