Skip to content
archcore logo archcore logo archcore

Configuration

CLI

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”
FieldTypeRequiredDescription
syncstringYesSync type: none, cloud, or on-prem
project_idintegerNoProject identifier for cloud/on-prem sync
archcore_urlstringNoServer URL for on-prem sync
languagestringNoLanguage code for document content

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 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 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 Required fields: archcore_url

Validation rules

Section titled “Validation rules”
  • sync must be one of: none, cloud, on-prem
  • Fields must be consistent with the sync type (e.g., archcore_url is forbidden for cloud)
  • language must not contain spaces
  • archcore_url must not be empty when sync is on-prem
  • Optional fields use omitempty — omitted fields use code-level defaults

Managing config

Section titled “Managing config”
Terminal window
# View current sync type
archcore config


# Get a specific value
archcore config get language


# Set a value
archcore config set language en

Next steps

Section titled “Next steps”