Configuration
Settings file
Section titled “Settings file”Configuration is stored in .archcore/settings.json. This file is created during archcore init and managed through archcore config.
Minimal config (local only)
Section titled “Minimal config (local only)”{ "sync": "none"}With language
Section titled “With language”{ "sync": "none", "language": "ru"}Fields
Section titled “Fields”| Field | Type | Required | Description |
|---|---|---|---|
sync | string | Yes | Sync type: none, cloud, or on-prem |
project_id | integer | No | Project identifier for cloud/on-prem sync |
archcore_url | string | No | Server URL for on-prem sync |
language | string | No | Language code for document content |
globals | array | No | Read-only external knowledge bases to mount. See Global sources |
Sync types
Section titled “Sync types”none — local only
Section titled “none — local only”Documents stay local. No server communication.
{ "sync": "none"}Allowed fields: sync, language, globals
Forbidden fields: project_id, archcore_url
cloud — cloud sync
Section titled “cloud — cloud sync”Syncs to https://app.archcore.ai.
{ "sync": "cloud", "project_id": 42}Allowed fields: sync, project_id, language, globals
Forbidden fields: archcore_url
on-prem — self-hosted server
Section titled “on-prem — self-hosted server”Syncs to a self-hosted Archcore server.
{ "sync": "on-prem", "project_id": 42, "archcore_url": "https://archcore.internal.company.com"}Allowed fields: sync, project_id, archcore_url, language, globals
Required fields: archcore_url
Global sources
Section titled “Global sources”The globals array mounts other .archcore/ knowledge bases — company standards, platform conventions, a monorepo root — into your project read-only. It is allowed for every sync type.
{ "sync": "none", "globals": [ { "id": "company-standards", "path": "../company-standards/.archcore" } ]}| Field | Required | Description |
|---|---|---|
id | Yes | Stable identifier; becomes the document source_id. Lowercase alphanumeric with hyphens (^[a-z0-9][a-z0-9-]*$), not the reserved value local, unique within the array |
path | Yes | Points at the global’s .archcore directory. Relative (including ../), absolute, or in-tree under .archcore/global/ |
Every declared global is mandatory — if its directory is absent, the MCP server fails fast at startup. Globals are read-only everywhere outside the MCP read tools, and local documents take precedence over a same-topic global.
See Global sources for the full model, vendoring, and the monorepo-root pattern.
Validation rules
Section titled “Validation rules”syncmust be one of:none,cloud,on-prem- Fields must be consistent with the sync type (e.g.,
archcore_urlis forbidden forcloud) languagemust not contain spacesarchcore_urlmust not be empty when sync ison-prem- Each
globalsentry must have a non-emptyid(lowercase alphanumeric with hyphens, notlocal) and non-emptypath;idmust be unique across the array - Optional fields use
omitempty— omitted fields use code-level defaults
Managing config
Section titled “Managing config”# View current sync typearchcore config
# Get a specific valuearchcore config get language
# Set a valuearchcore config set language enNext steps
Section titled “Next steps”- Commands — every
archcore configflag and subcommand. - Troubleshooting — settings-related errors.