Tether CLI

https://tether-cli.com/docs
Admin
Tether CLI is an open-source tool that automatically syncs development environments, including...
Tokens:4,984
Snippets:92
Trust Score:4.5
Update:4 months ago
Show doc for...
Tokens:
Raw
### Tether Team Setup

Source: https://tether-cli.com/docs

Command to initiate the interactive setup wizard for Tether's team synchronization features.

```bash
# Interactive setup wizard
tether team setup
```

--------------------------------

### npm Manifest Example

Source: https://tether-cli.com/docs

Example format for synchronizing global npm packages, listing one package per line.

```text
# Manifest: manifests/npm.txt
typescript
eslint
prettier
```

--------------------------------

### uv (Python) Package Manifest Example

Source: https://tether-cli.com/docs

Example manifest for synchronizing global Python packages installed via uv, listing one package per line.

```text
# Enable uv sync
tether config set packages.uv.enabled true

# Manifest: manifests/uv.txt
ruff
black
mypy
```

--------------------------------

### Install Tether CLI with Homebrew

Source: https://tether-cli.com/docs

Use Homebrew to install the Tether CLI. Ensure you have tapped the correct repository first.

```bash
brew tap paddo-tech/tap
brew install tether-cli
```

--------------------------------

### Start Tether Daemon

Source: https://tether-cli.com/docs

Starts the Tether background daemon, which is responsible for syncing and managing configurations.

```bash
tether daemon start
```

--------------------------------

### Verify Tether Setup

Source: https://tether-cli.com/docs

Check the status of the Tether daemon and view a list of synced files after initialization.

```bash
tether status
```

--------------------------------

### Homebrew Manifest Example

Source: https://tether-cli.com/docs

Example Brewfile format for synchronizing Homebrew formulae, casks, and taps, including desktop applications.

```ruby
# Manifest: manifests/Brewfile
tap "homebrew/cask"
brew "ripgrep"
brew "fd"
cask "visual-studio-code"
cask "slack"
cask "1password"
```

--------------------------------

### Tether Configuration File Example

Source: https://tether-cli.com/docs

Example TOML configuration file for Tether, detailing backend URL, security settings, dotfile paths, project configurations, and package manager enablement.

```toml
[backend]
url = "git@github.com:username/dotfiles.git"

[security]
encrypt_dotfiles = true
scan_secrets = true

[dotfiles]
files = [".zshrc", ".gitconfig", ".vimrc"]
dirs = [".config/nvim", ".ssh/config"]

[project_configs]
enabled = true
search_paths = ["~/Projects", "~/Work"]
patterns = [".env.local", ".claude/settings.json"]

[packages.brew]
enabled = true

[packages.npm]
enabled = true

[packages.pnpm]
enabled = false

[packages.bun]
enabled = false

[packages.gem]
enabled = false
```

--------------------------------

### Initialize Tether on Another Machine

Source: https://tether-cli.com/docs

Install Tether on a new machine and initialize it with an existing Git repository. Ensure you use the same encryption passphrase.

```bash
brew tap paddo-tech/tap && brew install tether-cli
tether init --repo git@github.com:username/dotfiles.git
```

--------------------------------

### Initialize Tether with Specific Repository

Source: https://tether-cli.com/docs

Initialize Tether and specify the Git repository URL directly. The daemon will not start automatically if the --no-daemon flag is used.

```bash
tether init [--repo <URL>] [--no-daemon]
```

--------------------------------

### Upgrade installed packages

Source: https://tether-cli.com/docs

Upgrades all installed packages across all enabled package managers.

```bash
tether upgrade
```

--------------------------------

### Manage configuration settings

Source: https://tether-cli.com/docs

Allows getting, setting, and editing configuration values. Supports nested keys for configuration and interactive management of dotfiles and feature toggles.

```bash
tether config get <KEY>
tether config set <KEY> <VALUE>
tether config edit
tether config dotfiles
tether config features              # List feature toggles
tether config features enable <F>   # Enable a feature
tether config features disable <F>  # Disable a feature
```

--------------------------------

### Add Team Repository

Source: https://tether-cli.com/docs

Clones the team repository and creates symlinks to team config files. This is the initial setup for a team's shared configurations.

```bash
tether team add git@github.com:org/team-dotfiles.git
```

--------------------------------

### List and uninstall packages

Source: https://tether-cli.com/docs

Lists installed packages across all managers and provides an interactive multi-select interface for uninstallation. Supports non-interactive listing and skipping confirmation prompts.

```bash
tether packages             # Interactive mode
tether packages --list      # Non-interactive list
```

--------------------------------

### Tether Feature Toggles Example: Team-Only Mode

Source: https://tether-cli.com/docs

Example of disabling personal sync features and enabling team-only features to configure Tether for team-only mode.

```bash
tether config features disable personal_dotfiles
tether config features disable personal_packages
tether config features enable team_dotfiles
```

--------------------------------

### Control the background daemon

Source: https://tether-cli.com/docs

Manages the Tether background daemon. Supports starting, stopping, restarting, viewing logs, and installing/uninstalling the service.

```bash
tether daemon <start|stop|restart|logs|install|uninstall>
```

--------------------------------

### Manage team sync repositories and secrets

Source: https://tether-cli.com/docs

Facilitates team synchronization by managing team repositories, organization mappings, and encrypted secrets. Supports setup, adding/listing teams, and managing secrets for team members and projects.

```bash
# Team management
tether team setup                     # Interactive wizard
tether team add <URL>                 # Add team repo
tether team list                      # List teams
tether team status                    # Show status
tether team enable/disable            # Toggle sync

# Organization mapping
tether team orgs add <ORG>            # Map GitHub org to team
tether team orgs list                 # List mapped orgs
tether team orgs remove <ORG>         # Unmap org

# Team secrets (age encryption)
tether team secrets add-recipient <KEY>   # Add member's public key
tether team secrets list-recipients       # List recipients
tether team secrets set <NAME>            # Set a secret
tether team secrets get <NAME>            # Get a secret
tether team secrets list                  # List all secrets

# Project secrets
tether team projects add <FILE>       # Share project secret
tether team projects list             # List shared secrets
tether team projects migrate          # Auto-migrate to team
tether team projects purge-personal   # Remove personal copies
```

--------------------------------

### Get Team Secret

Source: https://tether-cli.com/docs

Retrieves a previously set team secret. This command decrypts and displays the secret value.

```bash
tether team secrets get API_KEY
```

--------------------------------

### Initialize Tether on a New Machine

Source: https://tether-cli.com/docs

Initialize Tether on your current machine. This command prompts for Git repository configuration and an encryption passphrase.

```bash
tether init
```

--------------------------------

### Show differences between machines

Source: https://tether-cli.com/docs

Compares the current machine's configuration with another specified machine. Use `--machine` to target a specific machine.

```bash
tether diff [--machine <NAME>]
```

--------------------------------

### Tether Collaboration Commands

Source: https://tether-cli.com/docs

Commands for initializing, joining, adding files to, refreshing, listing, and removing collaborative projects. Requires write access for collaborators.

```bash
tether collab init              # Initialize collab for current project
tether collab join <URL>        # Join existing collab
tether collab add <FILE>        # Add secret file (e.g., .env)
tether collab refresh           # Re-encrypt for current collaborators
tether collab list              # List all collabs
tether collab remove            # Remove a collab
```

--------------------------------

### Tether Package Manager Configuration

Source: https://tether-cli.com/docs

Commands to enable specific package managers (e.g., Homebrew, npm) for global package synchronization.

```bash
tether config set packages.brew.enabled true
tether config set packages.npm.enabled true
```

--------------------------------

### Manually Trigger Tether Sync

Source: https://tether-cli.com/docs

Manually initiate a synchronization process. Use --dry-run to preview changes or --force to bypass conflict prompts.

```bash
tether sync [--dry-run] [--force]
```

--------------------------------

### Tether Machine Profile Creation

Source: https://tether-cli.com/docs

Commands to create new machine profiles for managing distinct sets of dotfiles and packages across different environments.

```bash
tether machines profile create work
tether machines profile create server
```

--------------------------------

### Manage machines and profiles

Source: https://tether-cli.com/docs

Handles machine management within the sync network, including listing, renaming, removing, and managing profile assignments.

```bash
tether machines <list|rename|remove|profile>
```

--------------------------------

### List All Teams

Source: https://tether-cli.com/docs

Displays a list of all Tether teams the user is a part of.

```bash
tether team list
```

--------------------------------

### View Full Daemon Log

Source: https://tether-cli.com/docs

Displays the complete content of the Tether daemon log file.

```bash
cat ~/.tether/daemon.log
```

--------------------------------

### Tether Machine Profile Assignment and Listing

Source: https://tether-cli.com/docs

Commands for assigning a profile to the current machine and listing all available machine profile assignments.

```bash
# Assign to current machine
tether machines profile set work

# View assignments
tether machines profile list
```

--------------------------------

### Manage ignore patterns and exclusions

Source: https://tether-cli.com/docs

Configures patterns to ignore during sync and manages per-machine file exclusions. Supports adding, listing, and removing patterns, as well as managing per-machine exclusions.

```bash
# Secret scanning patterns
tether ignore add <PATTERN>
tether ignore list
tether ignore remove <PATTERN>

# Per-machine file exclusions
tether ignore dotfile <FILE>
tether ignore project <PROJECT> <PATH>
tether ignore sync-list
tether ignore sync-remove <FILE>
```

--------------------------------

### Launch Tether TUI Dashboard

Source: https://tether-cli.com/docs

Run Tether without arguments to launch the interactive terminal dashboard for managing your synced environment.

```bash
tether
```

--------------------------------

### Resolve Sync Conflicts

Source: https://tether-cli.com/docs

Initiates the process to resolve synchronization conflicts between local and remote configurations.

```bash
tether resolve
```

--------------------------------

### Show file change history

Source: https://tether-cli.com/docs

Displays the history of file changes from the sync repository. Can show recent changes or history for a specific file.

```bash
tether history                   # Show recent changes
tether history <FILE>            # Show history for a specific file
```

--------------------------------

### View Daemon Logs

Source: https://tether-cli.com/docs

Displays the logs generated by the Tether daemon. This is useful for diagnosing issues with the background service.

```bash
tether daemon logs
```

--------------------------------

### Check Tether Key Existence

Source: https://tether-cli.com/docs

Checks if the Tether encryption key file exists at the default location.

```bash
ls ~/.tether/sync/.tether-key.age
```

--------------------------------

### List Team Projects

Source: https://tether-cli.com/docs

Lists the projects associated with the current team, including secrets shared from mapped organizations.

```bash
tether team projects list
```

--------------------------------

### Add Project Secret

Source: https://tether-cli.com/docs

Shares a project secret, such as a .env file, with the team. This makes the secret available to all team members working on the project.

```bash
tether team projects add .env
```

--------------------------------

### Restore files

Source: https://tether-cli.com/docs

Restores files from backups or Git history. Supports listing available backups, interactive restore, restoring from a specific timestamp, and restoring from Git history.

```bash
tether restore list              # List available backups
tether restore file              # Interactive restore
tether restore file --from <TS>  # Restore from specific timestamp
tether restore git               # Restore dotfiles from git history
```

--------------------------------

### Force Sync

Source: https://tether-cli.com/docs

Forces a synchronization, potentially overwriting local changes with remote ones or vice versa. Use with caution.

```bash
tether sync --force
```

--------------------------------

### Map GitHub Organization to Team

Source: https://tether-cli.com/docs

Maps a GitHub organization to a Tether team, enabling automatic sharing of project secrets from that organization to the team.

```bash
tether team orgs add github.com/acme-corp
```

--------------------------------

### Reset Tether Configuration

Source: https://tether-cli.com/docs

Resets the Tether configuration by stopping the daemon, removing the configuration directory, and re-initializing.

```bash
rm -rf ~/.tether
tether init
```

--------------------------------

### Resolve file conflicts

Source: https://tether-cli.com/docs

Interactively resolves file conflicts during synchronization. Options include keeping local, using remote, merging, or skipping the file.

```bash
tether resolve [FILE]
```

--------------------------------

### Tether Feature Toggles Management

Source: https://tether-cli.com/docs

Commands to list, enable, or disable feature toggles that control what Tether synchronizes, such as personal or team dotfiles and packages.

```bash
tether config features              # List all toggles
tether config features enable <F>   # Enable a feature
tether config features disable <F>  # Disable a feature
```

--------------------------------

### Migrate Project Secrets

Source: https://tether-cli.com/docs

Automatically migrates project secrets from mapped organizations to the current team. This ensures all necessary secrets are available.

```bash
tether team projects migrate
```

--------------------------------

### Tether Machine Profile Editing

Source: https://tether-cli.com/docs

Command to edit the configuration of a specific machine profile. Profiles manage distinct dotfile and package lists.

```bash
tether machines profile edit work
```

--------------------------------

### Tether Unlock and Lock Commands

Source: https://tether-cli.com/docs

Commands to unlock the cached encryption key when the daemon cannot decrypt, or to clear the cached key by locking.

```bash
tether unlock

tether lock
```

--------------------------------

### Manage age identity for team secrets

Source: https://tether-cli.com/docs

Manages the age identity used for encrypting team secrets. Supports initializing, showing public key, unlocking, locking, and resetting the identity.

```bash
tether identity init     # Generate new age identity
tether identity show     # Show your public key
tether identity unlock   # Unlock with passphrase
tether identity lock     # Clear cached key
tether identity reset    # Generate new (destroys old)
```

--------------------------------

### Switch Active Team

Source: https://tether-cli.com/docs

Switches the active Tether team to another team. This changes the context for subsequent commands.

```bash
tether team switch other
```

--------------------------------

### Remove Team

Source: https://tether-cli.com/docs

Completely removes a team and its associated configurations. Use with caution as this action is irreversible.

```bash
tether team remove
```

--------------------------------

### Tether Secret Detection Ignore Pattern

Source: https://tether-cli.com/docs

Command to add ignore patterns for secret detection to prevent false positives during sync.

```bash
tether ignore add 'EXAMPLE_KEY='
```

--------------------------------

### Stop Tether Daemon

Source: https://tether-cli.com/docs

Stops the Tether background daemon.

```bash
tether daemon stop
```

--------------------------------

### Purge Personal Project Secrets

Source: https://tether-cli.com/docs

Removes personal copies of project secrets, encouraging the use of the team-shared versions. This helps maintain consistency.

```bash
tether team projects purge-personal
```

--------------------------------

### Add Ignore Pattern for Secrets

Source: https://tether-cli.com/docs

Adds an ignore pattern to prevent Tether from detecting specific strings as secrets. Useful for safe patterns that should not be synced.

```bash
tether ignore add 'MY_SAFE_PATTERN='
```

--------------------------------

### Set Team Secret

Source: https://tether-cli.com/docs

Sets a secret for the team, which will be encrypted for all recipients. Use this to share sensitive information like API keys.

```bash
tether team secrets set API_KEY
```

--------------------------------

### Add Recipient for Team Secrets

Source: https://tether-cli.com/docs

Adds your public key as a recipient for team secrets, enabling you to receive encrypted secrets shared by the team.

```bash
tether team secrets add-recipient age1...
```

--------------------------------

### Unlock encryption key

Source: https://tether-cli.com/docs

Unlocks the cached encryption key using a passphrase, allowing access to encrypted secrets.

```bash
tether unlock
```

--------------------------------

### Lock encryption key

Source: https://tether-cli.com/docs

Clears the cached encryption key, effectively locking access to encrypted secrets until unlocked again.

```bash
tether lock
```

--------------------------------

### Disable Team

Source: https://tether-cli.com/docs

Disables a team without removing it. This can be used to temporarily stop syncing or accessing team resources.

```bash
tether team disable
```
Tokens:
Raw