Skip to content

Document cloud sync/bisync commands as Personal-workspace-only local mirror workflows #851

Closed

Description

@groksrc

Feature / UX Request

Mark rclone-based cloud sync/bisync commands as Personal-workspace local mirror commands in CLI help and docs.

Problem

The old rclone sync/bisync commands are still useful for Personal workspace local mirror workflows, but their help text does not clearly say that they are not a general Cloud/Teams sync facility.

With Team workspaces, users may reasonably expect bm cloud sync or bm cloud bisync to work for shared workspaces, but multi-user rclone bisync is not supported there.

Proposed Documentation/Help Updates

Update command help and relevant docs to say something like:

Personal workspace local mirror only. Not supported for Team workspaces.
Team workspaces are accessed through cloud API/MCP routing.

This should appear in:

  • bm cloud sync-setup --help
  • bm cloud sync --help
  • bm cloud bisync --help
  • bm cloud check --help
  • bm cloud bisync-reset --help
  • Any docs pages that describe cloud sync/bisync

Acceptance Criteria

  • Users can tell from --help that rclone sync/bisync is Personal-workspace-only.
  • Team workspace docs point users toward cloud API/MCP routing rather than local sync setup.
  • Existing Personal workspace rclone workflows remain documented.

Activity

  1. claude commented on May 24, 2026

    @claude
    Contributor

    Claude finished @groksrc's task in 3m 37s —— View job


    Triage & Implementation

    • Analyze issue and create todo list
    • Find CLI cloud command files (src/basic_memory/cli/commands/cloud/project_sync.py)
    • Update help text for all 5 commands (cloud sync, cloud bisync, cloud check, cloud bisync-reset, cloud sync-setup)
    • Update docs/cloud-cli.md — added notices in "Understanding the Sync Commands" and Command Reference "File Synchronization" sections
    • Add labels: documentation, enhancement
    • Commit changes (local commit 275ef81)
    • Push changes — blocked (see note below)

    Changes Made

    src/basic_memory/cli/commands/cloud/project_sync.py — All 5 rclone-based commands now include in their --help output:

    Personal workspace local mirror only.
    Not supported for Team workspaces — use cloud API/MCP routing instead.
    

    Commands updated: bm cloud sync, bm cloud bisync, bm cloud check, bm cloud bisync-reset, bm cloud sync-setup

    docs/cloud-cli.md — Two notices added:

    1. Under "Understanding the Sync Commands": a blockquote callout naming all five affected commands
    2. Under Command Reference > "File Synchronization": a short blockquote note

    Note: Push Blocked

    The branch push failed with remote: Permission to basicmachines-co/basic-memory.git denied to github-actions[bot]. This is a repository permission issue — the GitHub Actions workflow token doesn't have write access to push branches. A maintainer can either:

    • Cherry-pick commit 275ef81 manually, or
    • Grant the Actions bot write access in repository settings → Actions → General → Workflow permissions → Read and write
  2. added a commit that references this issue on Jun 10, 2026
    650f88a
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationenhancementNew feature or request

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions