Skip to content

oauth-xx/oauth-tty

Repository files navigation

Galtzo.com Logo by Aboling0, CC BY-SA 4.0 OAuth 1.0 Logo by Chris Messina, CC BY-SA 3.0, via Wikimedia Commons Yukihiro Matsumoto, Ruby Visual Identity Team, CC BY-SA 2.5

🖥️ OAuth::TTY

Version License: MIT Downloads Rank Open Source Helpers Depfu


Liberapay Goal Progress Sponsor Me on Github Buy me a coffee Donate on Polar Donate to my FLOSS or refugee efforts at ko-fi.com Donate to my FLOSS or refugee efforts using Patreon

A TTY Command Line Interface for interacting with OAuth 1.0 services.

Federated DVCS Repository Status Issues PRs Wiki CI Discussions
🧪 oauth-xx/oauth-tty on GitLab The Truth 💚 💚 💚 🏀 Tiny Matrix
🧊 oauth-xx/oauth-tty on CodeBerg An Ethical Mirror (Donate) 💚 ⭕️ No Matrix
🐙 oauth-xx/oauth-tty on GitHub A Dirty Mirror 💚 💚 💯 Full Matrix
🤼 OAuth Ruby Google Group "Active" 💚
🎮️ Discord Server Live Chat on Discord Let's talk about this library!

This library was written originally by Thiago Pinto in 2016 and bundled with the oauth gem. It was extracted into a separate library by Peter Boling in 2022 as part of the move to a stable version 1.0 for the oauth gem.

💡 Info you can shake a stick at

Tokens to Remember Gem name Gem namespace
Source Source on GitLab.com Source on CodeBerg.org Source on Github.com The best SHA: dQw4w9WgXcQ!
Documentation Discussion Current release on RubyDoc.info YARD on Galtzo.com BDFL Blog Wiki
Compliance License: MIT 📄ilo-declaration-img Security Policy Contributor Covenant 2.1 SemVer 2.0.0
Style Enforced Code Style Linter Keep-A-Changelog 1.0.0 Gitmoji Commits
Support Live Chat on Discord Get help from me on Upwork Get help from me on Codementor
Enterprise Support Get help from me on Tidelift
💡Subscribe for support guarantees covering all FLOSS dependencies!
💡Tidelift is part of Sonar!
💡Tidelift pays maintainers to maintain the software you depend on!
📊@Pointy Haired Boss: An enterprise support subscription is "never gonna let you down", and supports open source maintainers!
Comrade BDFL 🎖️ Follow Me on LinkedIn Follow Me on Ruby.Social Follow Me on Bluesky Contact BDFL My technical writing
... 💖 Find Me on WellFound: Find Me on CrunchBase My LinkTree More About Me 🧊 🐙 🛖 🧪

✨ Installation

Install the gem and add to the application's Gemfile by executing:

$ bundle add oauth-tty

If bundler is not being used to manage dependencies, install the gem by executing:

$ gem install oauth-tty

NOTE: You might see a warning like:

oauth-tty's executable "oauth" conflicts with oauth
Overwrite the executable? [yN]  y

The oauth executable from this gem is the extracted and repackaged executable from an old version of the oauth gem, so you should overwrite it.

🔧 Basic Usage

In a shell run oauth to start the console.

For now, please see the tests for other usage.

🔐 Security

See SECURITY.md.

🤝 Contributing

If you need some ideas of where to help, you could work on adding more code coverage, or if it is already 💯 (see below) check issues, or PRs, or use the gem and think about how it could be better.

We Keep A Changelog so if you make changes, remember to update it.

See CONTRIBUTING.md for more detailed instructions.

🚀 Release Instructions

See CONTRIBUTING.md.

Code Coverage

None yet!

🪇 Code of Conduct

Everyone interacting with this project's codebases, issue trackers, chat rooms and mailing lists agrees to follow the Contributor Covenant 2.1.

🌈 Contributors

Contributors

Made with contributors-img.

Also see GitLab Contributors: https://gitlab.com/oauth-xx/oauth-tty/-/graphs/main

⭐️ Star History

Star History Chart

📌 Versioning

This Library adheres to Semantic Versioning 2.0.0. Violations of this scheme should be reported as bugs. Specifically, if a minor or patch version is released that breaks backward compatibility, a new version should be immediately released that restores compatibility. Breaking changes to the public API will only be introduced with new major versions.

📌 Is "Platform Support" part of the public API?

Yes. But I'm obligated to include notes...

SemVer should, but doesn't explicitly, say that dropping support for specific Platforms is a breaking change to an API. It is obvious to many, but not all, and since the spec is silent, the bike shedding is endless.

dropping support for a platform is both obviously and objectively a breaking change

To get a better understanding of how SemVer is intended to work over a project's lifetime, read this article from the creator of SemVer:

As a result of this policy, and the interpretive lens used by the maintainer, you can (and should) specify a dependency on these libraries using the Pessimistic Version Constraint with two digits of precision.

For example:

spec.add_dependency("oauth-tty", "~> 1.0")

See CHANGELOG.md for a list of releases.

📄 License

The gem is available as open source under the terms of the MIT License License: MIT. See LICENSE.txt for the official Copyright Notice.

© Copyright

  • Copyright (c) 2021-2022, 2025 Peter H. Boling, of Galtzo.com Galtzo.com Logo by Aboling0, CC BY-SA 4.0 , and oauth-tty contributors
  • Copyright (c) 2016-2017 Thiago Pinto

🤑 One more thing

You made it to the bottom of the page, so perhaps you'll indulge me for another 20 seconds. I maintain many dozens of gems, including this one, because I want Ruby to be a great place for people to solve problems, big and small. Please consider supporting my efforts via the giant yellow link below, or one of the others at the head of this README.

Buy me a latte

About

OAuth 1.0 TTY Command Line Interface

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Packages

No packages published

Contributors 2

  •  
  •