Skip to content

Quick reference

jahwag edited this page Aug 22, 2024 · 11 revisions

Quick reference

CLI Commands

Task Command
Login claudesync api login <provider>
Logout claudesync api logout
Select Org claudesync organization select
List Orgs claudesync organization ls
Select Project claudesync project select
Create Project claudesync project create
List Projects claudesync project ls
Archive Project claudesync project archive
Sync Files claudesync project sync [--category <name>]
Check Status claudesync status
List Files claudesync ls
Config claudesync config <subcommand>
Schedule Sync claudesync schedule
List Submodules claudesync submodule ls
Create Submodules claudesync submodule create
List Chats claudesync chat ls
Sync Chats claudesync chat sync
Delete Chats claudesync chat rm [-a]
Create Chat claudesync chat create [--name <name>] [--project <uuid>]
Send Message claudesync chat send <message> [--chat <uuid>] [--timezone <tz>]

Configuration

Task Command
View Config claudesync config ls
Set Config claudesync config set <key> <value>
Get Config claudesync config get <key>
Add File Category claudesync config category add <name> --description <desc> --patterns <pattern1> [<pattern2> ...]
Remove Category claudesync config category remove <name>
Update Category claudesync config category update <name> [--description <desc>] [--patterns <pattern1> <pattern2> ...]
List Categories claudesync config category ls

Key Options:

  • active_provider: Current API provider
  • active_organization_id: Selected organization ID
  • active_project_id: Selected project ID
  • active_project_name: Selected project name
  • local_path: Local sync directory path
  • upload_delay: Delay between uploads (seconds)
  • max_file_size: Max file size (bytes)
  • two_way_sync: Enable/disable (true/false). NOTE: Experimental feature.
  • prune_remote_files: Enable/disable automatic deletion of remote files not present locally (true/false)
  • curl_use_file_input: Use file input for curl provider (true/false)
  • log_level: Set logging level (e.g., INFO, DEBUG)

Examples:

claudesync config set upload_delay 0.5
claudesync config set two_way_sync true
claudesync config set prune_remote_files true

Note: Two-way sync is experimental. Use with caution as it may lead to conflicts.

Scheduled Syncing

Set up automatic syncing at regular intervals:

claudesync schedule

Follow the prompts to set your desired sync frequency.

Ignore Rules

Create a .claudeignore file to specify files/patterns to ignore (similar to .gitignore). Example .claudeignore:

*.log
temp/
secrets.txt

File Categories

You can create and manage file categories for more granular control over syncing:

claudesync config category add production_code --description "Production source code" --patterns "src/**/*.java" "src/**/*.py"
claudesync project sync --category production_code

Submodules

Detect and manage submodules within your project:

claudesync submodule ls
claudesync submodule create

Chat Management

Manage and interact with chat conversations:

claudesync chat ls
claudesync chat create --name "New Chat" --project <project_uuid>
claudesync chat send "Hello, Claude!" --chat <chat_uuid>
claudesync chat sync

Clone this wiki locally