-
Notifications
You must be signed in to change notification settings - Fork 0
box init
mrdulasolutions edited this page May 25, 2026
·
1 revision
Bootstrap a workspace on the local Box Drive mount. Folder-only — no Hub workspaces in this variant (Hubs require Box AI which isn't reachable air-gapped).
/box-init [workspace-name] [--team=<team>] [--parent=<relative-path>]
Examples:
-
/box-init— workspace namedbox-memoryat the Box Drive root -
/box-init my-vault --team=engineering— workspace plus team subtree -
/box-init my-vault --parent=Projects— workspace under<mount>/Projects/my-vault
- Verify backend via box-drive-detect. If mount missing or unwritable, surface error and stop. Never escalates to network.
-
Resolve path at
<box_drive_mount>/<parent>/<workspace-name> -
Check existing — if
_box-memory.jsonexists, don't overwrite. Offer use-existing / alongside / re-init (confirm twice for last). -
Create folders via
mkdir -p:memories/,files/,companions/(folder layout),teams/<default>/memories/,teams/<default>/files/ - Acquire workspace lock (Schema — lockfile protocol)
-
Write
_box-memory.jsonwithbackend: local,local_backend: {...}, default settings -
Seed
_index.jsonin every memory-holding folder - Release lock
- Write workspace README at the workspace root
-
Report — name, path, default team, settings; suggest
/box-writeas the next step
backend: local
local_backend: { ...from box-drive-detect... }
tier: personal # no API probe available; declare manually if Business+
capabilities:
custom_metadata_templates: false
body_search: false
metadata_query_api: false
retention_policies: false
legal_holds: false
compliance: []
settings:
default_team: default
companion_layout: sibling
include_superseded_in_recall: false
rebuild_index_on_drift: true
# Compliance declaration (optional)
compliance_target: null
box_plan: null
box_addons: []
box_zone: null
baa_signed: null- No tier probing — no Box API. User declares tier-relevant fields if needed.
- No metadata template creation — Box API operation; air-gap incompatible.
-
No
--as-hubflag — Box Hubs require Box AI. -
file_idisnullin index entries — Box Drive assigns Box file IDs only after sync.local_path(relative to workspace root) is the canonical key. -
workspace_owner_app: "box-memory-onprem"in config — explicit which variant created it.
- Box Drive not detected → see box-drive-detect guidance
- Mount not writable → check Box Drive is running and signed in
-
Lock cannot be acquired after retries → another writer is active;
/box-index-rebuildto inspect for stale locks
Re-running with the same name is safe: re-use existing folders, never overwrites _box-memory.json without confirmation, preserves existing _index.json content.
-
Schema —
_box-memory.jsonshape + lockfile protocol - box-drive-detect — pre-flight check
- box-airgap-status — post-init trust posture verification
- Source:
skills/box-init/SKILL.md
box-memory-onprem · MIT · Repo · Latest release · Cloud variant · Cloud wiki
Getting started
Concepts
Compliance
Skills reference
- Skills Reference (all)
- box-drive-detect
- box-airgap-status
- box-init
- box-write
- box-recall
- box-companion
- box-team
- box-status
- box-index-rebuild
Operations
Project