bluesky_cli 0.0.2 bluesky_cli: ^0.0.2 copied to clipboard
A powerful CLI tool that allows Bluesky Social's APIs to be executed from the command line powered by Dart language.
A Powerful and Useful CLI Tool for Bluesky Social Powered By Dart Language 🎯
1. Guide 🌎 #
A powerful CLI tool that allows Bluesky Social's APIs to be executed from the command line powered by Dart language.
Show some ❤️ and star the repo to support the project.
1.1. Getting Started ⚡ #
1.1.1. Install #
dart pub global activate bluesky_cli
1.1.2. Usage #
A useful and powerful CLI tool to use Bluesky Social's APIs.
Usage: bsky <command> [arguments]
Global options:
-h, --help Print this usage information.
--handle Bluesky handle for authentication.
(defaults to environment variable "BLUESKY_HANDLE")
--password Bluesky password for authentication.
(defaults to environment variable "BLUESKY_PASSWORD")
--service Name of the service sending the request. Defaults to "bsky.social".
Available commands:
show-timeline Show the timeline of authenticated user.
Run "bsky help <command>" for more information about a command.
1.1.3. Authentication #
The following methods are available to authenticate with Bluesky Social via this CLI tool.
1.1.3.1. Global Options
Authentication data can be specified for handle
and password
in Global Options.
bsky show-timeline --handle=shinyakato.dev --password=xxxxxxxxx
1.1.3.2. Environment Variables
By setting the authentication data in the environment variable, the specification of authentication data in Global Options can be omitted.
Environment Variable | Equivalent Option |
---|---|
BLUESKY_HANDLE | handle |
BLUESKY_PASSWORD | password |
Then you can call like:
bsky show-timeline
1.2. Contribution 🏆 #
If you would like to contribute to bluesky_cli, please create an issue or create a Pull Request.
There are many ways to contribute to the OSS. For example, the following subjects can be cobluesky_cliered:
- There are request parameters or response fields that are not implemented.
- Documentation is outdated or incomplete.
- Have a better way or idea to achieve the functionality.
- etc...
You can see more details from resources below:
Or you can create a discussion if you like.
Feel free to join this development, diverse opinions make software better!
1.3. Support ❤️ #
The simplest way to show us your support is by giving the project a star at GitHub and Pub.dev.
You can also support this project by becoming a sponsor on GitHub:
You can also show on your repository that your app is made with bluesky_cli by using one of the following badges:
[![Powered by bluesky_cli](https://img.shields.io/badge/Powered%20by-bluesky_cli-00acee.svg)](https://github.com/myConsciousness/atproto.dart)
[![Powered by bluesky_cli](https://img.shields.io/badge/Powered%20by-bluesky_cli-00acee.svg?style=flat-square)](https://github.com/myConsciousness/atproto.dart)
[![Powered by bluesky_cli](https://img.shields.io/badge/Powered%20by-bluesky_cli-00acee.svg?style=for-the-badge)](https://github.com/myConsciousness/atproto.dart)
1.4. License 🔑 #
All resources of bluesky_cli is provided under the BSD-3
license.
Copyright 2023 Kato Shinya. All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided the conditions.
Note
License notices in the source are strictly validated based on.github/header-checker-lint.yml
. Please check header-checker-lint.yml for the permitted standards.
1.5. More Information 🧐 #
bluesky_cli was designed and implemented by Kato Shinya (@myConsciousness).