~cosmicrose/sourcehut_cli

A CLI for sourcehut

55ea640 Add some filtering flags

a month ago

1f662ec Fix CONTRIBUTING.md links

a month ago

#Sourcehut.CLI

A CLI wrapper for sr.ht.

This project is in the early stages, so don't use it yet. Or do use it, and give me feedback.

#Installation

Once this package is published to hex.pm, you'll be able to install it as an escript.

mix escript.install hex sourcehut_cli

This will install the script to ~/.mix/escripts, which you should add to your PATH environment variable.

#Usage

Set up authorization by creating a file called config.toml with the following contents:

[auth]
token = "Your Oauth2 personal access token"

For a top-level help menu:

srht --help

For help with a subcommand:

srht help <subcommand>

#Maintainer

This project was developed by Rosa Richter. You can get in touch with her on Keybase.io.

#Contributing

Questions and pull requests are more than welcome. I follow Elixir's tenet of bad documentation being a bug, so if anything is unclear, please file an issue! Ideally, my answer to your question will be in an update to the docs.

Please see CONTRIBUTING.md for all the details you could ever want about helping me with this project.

Note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

#License

MIT License

Copyright 2021 Rosa Richter

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.