gemstash-authorize(1)

📦
version 2.8.2 · 2 versions
, in nixpkgs unstable

🌸 NAME — gemstash-authorize 🌸

Okay bestie, welcome to the gemstash-authorize(1) manual page. This is the command that adds or removes authorization to interact with privately stored gems. No cap. 💖

✨ SYNOPSIS ✨

gemstash authorize [permissions] [--remove] [--list] [--key SECURE_KEY]
[--name NAME] [--config-file FILE]

🦋 DESCRIPTION 🦋

Adds or removes authorization to interact with privately stored gems. That’s the main-character job, periodt. 💅

Any arguments will be used as specific permissions. Valid permissions include push, yank, and fetch. If no permissions are provided, then all permissions will be granted — including any that may be added in future versions of Gemstash. Future-proof queen. 👑

✨ Usage ✨

gemstash authorize
gemstash authorize push yank
gemstash authorize push --name my-auth
gemstash authorize yank --key <secure-key>
gemstash authorize --remove --key <secure-key>
gemstash authorize --list

🎀 OPTIONS 🎀

  • --config-file FILE — specify the config file to use. If you aren’t using the default config file at ~/.gemstash/config.yml or ~/.gemstash/config.yml.erb, then you must specify the config file via this option. 🗂️
  • --key SECURE_KEY — specify the API key to affect. This should be the actual key value, not a name. This option is required when using --remove but is optional otherwise. If adding an authorization, using this will either create or update the permissions for the specified API key. If missing, a new API key will always be generated. Note that a key can only have a maximum length of 255 chars. 🔑
  • --name — name of the authorization. The synopsis shows the value as [--name NAME]. Purely for ease of identification, not required. 🏷️
  • --remove — remove an authorization rather than add or update one. When removing, permission values are not allowed. The --key <secure-key> option is required. 🚨
  • --list — list current authorizations. Provide --name or --key to show only one result. 📋
🚨 Removing is strict, bestie: no permission values allowed, and --key <secure-key> is required. Also remember --key wants the actual key value, not a name — and keys max out at 255 chars. 💅

Source/manual sign-off: gemstash-authorize(1) — dated October 9, 2015. 💖🎀

📦 where this page comes from