commit-in-public

1.0.1 • Public • Published

Commit in Public

Share your git commits on social media automatically. Currently supports Bluesky, with more platforms coming soon!

Installation

npm install -g commit-in-public

The installation will guide you through an interactive setup where you can:

  1. Connect your Bluesky account
  2. Choose your share tag (e.g., "share" becomes "#share")
  3. Configure whether to remove the tag from posts
  4. Set up automatic sharing via git hooks (optional)

Usage

After installation, simply include your configured tag in your commit messages:

git commit -m "Added dark mode support #share"

Depending on your configuration:

  • With tag removal (default): Posts "Added dark mode support" to Bluesky
  • Without tag removal: Posts "Added dark mode support #share" to Bluesky

Git Hooks

During setup, you can choose to install a git hook that automatically checks for your share tag after each commit. If you choose not to install the hook, you can manually share commits by running:

npx commit-in-public

Reconfiguring

Need to change your settings? Run the setup again:

npx commit-in-public-setup

Configuration

Your settings are stored securely using configstore. Configuration files are located at:

  • macOS: ~/Library/Preferences/commit-in-public-nodejs
  • Linux: ~/.config/commit-in-public-nodejs
  • Windows: %APPDATA%/commit-in-public-nodejs

Configuration Options

  • Bluesky Handle: Your Bluesky account (e.g., user.bsky.social)
  • Share Tag: The tag that triggers sharing (automatically prefixed with #)
  • Tag Removal: Whether to remove the share tag before posting
  • Git Hook: Automatic sharing after commits

Security

Your Bluesky app password is stored securely in your system's configuration. Never share your configuration directory or commit it to version control.

License

MIT

Package Sidebar

Install

npm i commit-in-public

Weekly Downloads

2

Version

1.0.1

License

MIT

Unpacked Size

10.2 kB

Total Files

5

Last publish

Collaborators

  • chrisgscott