-
-
Notifications
You must be signed in to change notification settings - Fork 69
Quick reference
Jahziah Wagner edited this page Sep 18, 2024
·
11 revisions
Here's the updated quick reference for ClaudeSync:
| Task | Command |
|---|---|
| Login | claudesync auth login [--provider <provider>] |
| Logout | claudesync auth logout |
| List Auth | claudesync auth ls |
| Select Org | claudesync organization set |
| List Orgs | claudesync organization ls |
| Select Project | claudesync project set [-a] |
| Create Project | claudesync project create [options] |
| List Projects | claudesync project ls [-a] |
| Archive Project | claudesync project archive |
| Sync Files | claudesync push [--category <name>] [--uberproject] |
| List Files | claudesync file ls |
| Config | claudesync config <subcommand> |
| Schedule Sync | claudesync sync schedule |
| List Submodules | claudesync submodule ls |
| Create Submodules | claudesync submodule create |
| List Chats | claudesync chat ls |
| Sync Chats | claudesync chat pull |
| Delete Chats | claudesync chat rm [-a] |
| Create Chat | claudesync chat init [--name <name>] [--project <uuid>] |
| Send Message | claudesync chat message <message> [--chat <uuid>] [--timezone <tz>] |
| 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 rm <name> |
| Update Category | claudesync config category update <name> [--description <desc>] [--patterns <pattern1> <pattern2> ...] |
| List Categories | claudesync config category ls |
| Set Default Category | claudesync config category set-default <category> |
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) -
prune_remote_files: Enable/disable automatic deletion of remote files not present locally (true/false) -
log_level: Set logging level (e.g., INFO, DEBUG) -
submodule_detect_filenames: List of filenames to detect submodules
Examples:
claudesync config set upload_delay 0.5
claudesync config set two_way_sync true
Note: Two-way sync is experimental. Use with caution as it may lead to conflicts.
Toggle pruning (deletion) of remote files not present locally:
claudesync config set prune_remote_files true
Set up automatic syncing at regular intervals:
claudesync sync schedule
Follow the prompts to set your desired sync frequency.
Create a .claudeignore file to specify files/patterns to ignore (similar to .gitignore).
Example .claudeignore:
*.log
temp/
secrets.txt
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 push --category production_code
Detect and manage submodules within your project:
claudesync submodule ls
claudesync submodule create
Manage and interact with chat conversations:
claudesync chat ls
claudesync chat init --name "New Chat" --project <project_uuid>
claudesync chat message "Hello, Claude!" --chat <chat_uuid>
claudesync chat pull