This commit is contained in:
@@ -1,12 +1,13 @@
|
|||||||
# bird 🐦 — fast X CLI for tweeting, replying, and reading
|
# bird 🐦 — fast X CLI for tweeting, replying, and reading
|
||||||
|
|
||||||
`bird` is a fast X CLI for tweeting, replying, and reading via X/Twitter GraphQL through twitter safe relay.
|
`bird` is a fast X CLI for tweeting, replying, and reading via X/Twitter GraphQL through
|
||||||
|
[twitter safe relay](https://github.com/fa0311/twitter_api_safe_relay).
|
||||||
|
|
||||||
## Disclaimer
|
## Disclaimer
|
||||||
|
|
||||||
This project uses X/Twitter’s [**documented**](https://github.com/fa0311/TwitterInternalAPIDocument) internal web
|
This project uses X/Twitter’s [**documented**](https://github.com/fa0311/TwitterInternalAPIDocument) internal web
|
||||||
GraphQL API through twitter safe relay. X can change endpoints, query IDs, and anti-bot behavior at any time —
|
GraphQL API through [twitter safe relay](https://github.com/fa0311/twitter_api_safe_relay). X can change endpoints,
|
||||||
**expect this to break without notice**.
|
query IDs, and anti-bot behavior at any time — **expect this to break without notice**.
|
||||||
|
|
||||||
## Install
|
## Install
|
||||||
|
|
||||||
@@ -17,7 +18,7 @@ npm config set @yuta:registry=https://git.yutakobayashi.com/api/packages/yuta/np
|
|||||||
npm install -g @yuta/bird
|
npm install -g @yuta/bird
|
||||||
|
|
||||||
# one-shot (no install)
|
# one-shot (no install)
|
||||||
npx -y @yuta/bird whoami
|
npx -y --@yuta:registry=https://git.yutakobayashi.com/api/packages/yuta/npm/ @yuta/bird whoami
|
||||||
```
|
```
|
||||||
|
|
||||||
Nix flakes:
|
Nix flakes:
|
||||||
@@ -26,12 +27,6 @@ Nix flakes:
|
|||||||
nix run git+https://git.yutakobayashi.com/yuta/bird -- --help
|
nix run git+https://git.yutakobayashi.com/yuta/bird -- --help
|
||||||
```
|
```
|
||||||
|
|
||||||
Homebrew (macOS, prebuilt Bun binary):
|
|
||||||
|
|
||||||
```bash
|
|
||||||
brew install steipete/tap/bird
|
|
||||||
```
|
|
||||||
|
|
||||||
## Quickstart
|
## Quickstart
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
@@ -200,8 +195,8 @@ Global options:
|
|||||||
|
|
||||||
## Authentication (GraphQL)
|
## Authentication (GraphQL)
|
||||||
|
|
||||||
`bird` does not handle Twitter authentication locally. It sends Twitter API-compatible requests to twitter safe relay,
|
`bird` does not handle Twitter authentication locally. It sends Twitter API-compatible requests to
|
||||||
and the relay handles authentication.
|
[twitter safe relay](https://github.com/fa0311/twitter_api_safe_relay), and the relay handles authentication.
|
||||||
|
|
||||||
Write operations:
|
Write operations:
|
||||||
- `tweet`/`reply` primarily use GraphQL (`CreateTweet`).
|
- `tweet`/`reply` primarily use GraphQL (`CreateTweet`).
|
||||||
|
|||||||
Reference in New Issue
Block a user