Something went wrong. Try again.
Rust CLI for tangled forked from dunkirk.sh/tangled-cli
Something went wrong. Try again.
6.2 kB · 322 lines
Markdown
# Getting Started with Tangled CLI
This guide will help you get up and running with the Tangled CLI.
## Installation
### Prerequisites
- Rust toolchain 1.70 or later
- Git
- A Bluesky/AT Protocol account
### Build from Source
1. Clone the repository:
```sh
git clone https://tangled.org/tangled/tangled-cli
cd tangled-cli
```
2. Build the project:
```sh
cargo build --release
```
3. The binary will be available at `target/release/tangled-cli`. Optionally, add it to your PATH or create an alias:
```sh
alias tangled='./target/release/tangled-cli'
```
### Install from AUR (Arch Linux)
If you're on Arch Linux, you can install from the AUR:
```sh
yay -S tangled-cli-git
```
## First Steps
Top-level commands are optimized for day-to-day use and can infer context from a
Tangled git remote where possible. The explicit API-shaped command tree remains
available under `tangled api ...`, such as `tangled api repo list`.
### 1. Authenticate
Login with your AT Protocol credentials (your Bluesky account):
```sh
tangled auth login
```
You'll be prompted for your handle (e.g., `alice.bsky.social`) and password. If you're using a custom PDS, specify it with the `--pds` flag:
```sh
tangled auth login --pds https://your-pds.example.com
```
Your credentials are stored securely in your system keyring.
### 2. Check Your Status
Verify you're logged in:
```sh
tangled auth status
```
### 3. List Your Repositories
See all your repositories:
```sh
tangled repo list
```
Or view someone else's public repositories:
```sh
tangled repo list --user alice.bsky.social
```
### 4. Create a Repository
Create a new repository on Tangled:
```sh
tangled repo create my-project --description "My awesome project"
```
By default, repositories are created on the default knot (`knot1.tangled.sh`). You can specify a different knot:
```sh
tangled repo create my-project --knot knot1.tangled.sh
```
### 5. Clone a Repository
Clone a repository to start working on it:
```sh
tangled repo clone alice/my-proj…