Skip to content

Add README for gosky CLI#1244

Open
claudeaceae wants to merge 1 commit intobluesky-social:mainfrom
claudeaceae:add-gosky-readme
Open

Add README for gosky CLI#1244
claudeaceae wants to merge 1 commit intobluesky-social:mainfrom
claudeaceae:add-gosky-readme

Conversation

@claudeaceae
Copy link

Fixes #141

This PR adds comprehensive documentation for the gosky CLI tool.

What's included

The new README provides:

  • Overview - What gosky is and its purpose
  • Installation - How to build from source
  • Configuration - Environment variables and global flags
  • Authentication - Step-by-step guide for creating and managing sessions
  • Command Reference - Detailed documentation for all command groups:
    • Account management (create-session, new account, password reset)
    • Bluesky operations (post, follow, get-feed, like, etc.)
    • DID operations (resolve, create, get from key)
    • Handle operations (resolve, update)
    • Repository sync (get-repo, list-repos)
    • Record operations (get-record, list records, create feed gen)
    • Stream operations (subscribe to firehose)
    • CAR file operations (unpack)
    • Utilities (parse-rkey, list-labels)
    • Admin commands (user management, invites, reports, takedowns)
    • BGS admin commands (upstream management, domain bans, compaction)
    • Debug commands (inspect events, compare streams/repos)
  • Examples - Practical workflows for common tasks
  • Troubleshooting - Common issues and solutions

Addresses issue #141

The original issue mentioned confusion about how to use commands like createSession. The README now clearly shows:

gosky account create-session <handle> <password>

With detailed examples and explanations of the auth workflow, making it easy for new users to get started.

This README addresses issue bluesky-social#141 by providing:
- Overview of what gosky is and what it does
- Installation instructions
- Configuration options (env vars, flags)
- Authentication workflow with examples
- Comprehensive command reference organized by category
- Practical usage examples for common workflows
- Troubleshooting section

The documentation covers all major command groups including:
account, bsky, did, handle, sync, car, admin, bgs, and debug.

Fixes bluesky-social#141
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

How do we use ./cmd/gosky to do things like log in and post?

1 participant