@harveyrandall/bsky-cli 1.0.0

package/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Harvey Randall
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,229 @@
+# bsky-cli
+
+<!-- badges -->
+[![CI](https://github.com/harveyrandall/bsky-cli/actions/workflows/ci.yml/badge.svg)](https://github.com/harveyrandall/bsky-cli/actions/workflows/ci.yml)
+[![npm version](https://img.shields.io/npm/v/@harveyrandall/bsky-cli)](https://www.npmjs.com/package/@harveyrandall/bsky-cli)
+[![license](https://img.shields.io/github/license/harveyrandall/bsky-cli)](LICENSE.md)
+[![downloads](https://img.shields.io/npm/dm/@harveyrandall/bsky-cli)](https://www.npmjs.com/package/@harveyrandall/bsky-cli)
+
+A command-line client for [Bluesky](https://bsky.app), built with TypeScript.
+
+## Install
+
+### npm / yarn / pnpm / bun
+
+Requires Node.js >= 22.
+
+```bash
+npm install -g @harveyrandall/bsky-cli
+# or
+yarn global add @harveyrandall/bsky-cli
+# or
+pnpm add -g @harveyrandall/bsky-cli
+# or
+bun add -g @harveyrandall/bsky-cli
+```
+
+### Homebrew (macOS / Linux)
+
+```bash
+brew install harveyrandall/bsky-cli
+```
+
+### Download a binary
+
+Standalone binaries for macOS, Linux, and Windows are attached to every
+[GitHub Release](https://github.com/harveyrandall/bsky-cli/releases).
+
+<details>
+<summary>Build from source</summary>
+
+```bash
+git clone https://github.com/harveyrandall/bsky-cli.git
+cd bsky-cli
+corepack enable
+yarn install
+yarn build
+yarn link:global   # registers `bsky` globally
+```
+
+To uninstall:
+
+```bash
+yarn unlink:global
+```
+
+</details>
+
+## Authentication
+
+### Interactive login
+
+```bash
+bsky login alice.bsky.social            # prompts for password (hidden input)
+bsky login alice.bsky.social mypassword  # or pass directly
+```
+
+### Environment variables
+
+All configuration can be set via environment variables, useful for CI and scripts:
+
+| Variable | Description |
+|----------|-------------|
+| `BSKY_HANDLE` | Bluesky handle |
+| `BSKY_PASSWORD` | App password |
+| `BSKY_HOST` | PDS host URL (default: `https://bsky.social`) |
+| `BSKY_BGS` | BGS host URL (default: `https://bsky.network`) |
+| `BSKY_PROFILE` | Profile name (same as `--profile`) |
+
+Precedence: CLI args > environment variables > config file.
+
+```bash
+# No login needed - authenticate directly from env
+BSKY_HANDLE=alice.bsky.social BSKY_PASSWORD=secret bsky tl
+```
+
+### Piped input
+
+```bash
+echo "$APP_PASSWORD" | bsky login alice.bsky.social
+```
+
+### Multiple accounts
+
+Use `--profile` / `-p` to manage separate accounts:
+
+```bash
+bsky login alice.bsky.social -p personal
+bsky login bob.bsky.social -p work
+
+bsky tl -p personal
+bsky tl -p work
+bsky -p ? tl              # list all profiles
+```
+
+## Commands
+
+### Feed
+
+```
+bsky timeline|tl [-H handle] [-n count]
+bsky stream [--cursor] [-H handle] [--pattern regex] [--pattern-flags flags]
+bsky thread <uri> [-n depth]
+```
+
+### Posting
+
+```
+bsky post <text> [--stdin] [-i image...] [--image-alt alt...] [--video path] [--video-alt alt]
+bsky reply <uri> <text>
+bsky quote <uri> <text>
+bsky delete <uri...>
+```
+
+### Engagement
+
+```
+bsky like <uri...>
+bsky likes <uri>
+bsky repost <uri...>
+bsky reposts <uri>
+```
+
+### Bookmarks
+
+```
+bsky bookmarks create <uri...>
+bsky bookmarks delete <uri...>
+bsky bookmarks get [-n count]
+```
+
+### Social
+
+```
+bsky follow <handle...>
+bsky unfollow <handle...>
+bsky follows [-H handle]
+bsky followers [-H handle]
+bsky block <handle...>
+bsky unblock <handle...>
+bsky blocks
+bsky mute <handle...>
+```
+
+### Discovery
+
+```
+bsky search <terms...> [-n count]
+bsky search-users <terms...> [-n count]
+```
+
+### Account
+
+```
+bsky profile [-H handle]
+bsky profile-update [displayname] [description] [--avatar file] [--banner file]
+bsky session
+bsky notifs|notification [-a]
+bsky invite-codes [--used]
+bsky app-password list|add|revoke
+bsky report <handle> [--comment text]
+bsky mod-list <handles...> [--name] [--desc]
+```
+
+### Utilities
+
+```
+bsky completions bash|zsh|fish
+```
+
+## Global flags
+
+| Flag | Description |
+|------|-------------|
+| `--json` | Output as JSON |
+| `-p, --profile <name>` | Use a named profile |
+| `-v, --verbose` | Verbose output |
+| `--version` | Show version |
+
+## Shell completions
+
+```bash
+# Bash
+bsky completions bash >> ~/.bashrc
+
+# Zsh
+bsky completions zsh >> ~/.zshrc
+
+# Fish
+bsky completions fish > ~/.config/fish/completions/bsky.fish
+```
+
+## Development
+
+```bash
+yarn dev             # run via tsx (no build needed)
+yarn build           # build to dist/
+yarn typecheck       # tsc --noEmit
+yarn test:run        # run tests once
+yarn test:coverage   # run tests with coverage
+yarn link:global     # build + register globally
+yarn unlink:global   # remove global symlink
+```
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for the full contributor guide.
+
+## Roadmap
+
+- [ ] Direct messages
+- [ ] List creation and management
+- [ ] Starter packs
+- [ ] Moderation lists
+- [ ] Post labels
+- [ ] Auto alt-text for images and videos
+- [ ] OAuth login support
+- [ ] Docker BuildKit for standalone binary builds
+
+## License
+
+[MIT](LICENSE.md)