🌟 Community Feature Challenge: Development Experience 🌟

[gemanor]

This is one of our 10 community feature challenges, and we want your input on how we can enhance the Permit CLI in the area of Permit.io Cloud Developer Experience. This is a space for you to share your ideas on what would make this part of the CLI even better!

How to Participate

• Submit Your Proposal: Comment below with your detailed feature idea. Be sure to explain how it would work and why it would be valuable for users.
• Vote for Your Favorites: Show support for your favorite ideas by upvoting them. Your votes will help us identify the most impactful proposals.
• Win a Bounty: The idea with the most upvotes will be selected, and we’ll put a bounty on it! This means that you (or another contributor) could bring this feature to life and earn a reward.

Why Join In?

• Shape the Future: Your input will directly influence Permit CLI’s growth.
• Community Recognition: Contributing ideas or supporting others’ ideas lets you stand out as a valuable community member.
• Collaborative Ownership: Together, we’ll build a CLI that truly reflects the community’s needs and creativity.

What’s Next?

We’ll keep this challenge open for proposals and upvotes until November 10th, 2024. Once the top idea is chosen, we’ll update this issue with details on the bounty and the next steps for development.

Thank you for helping us make the Permit CLI even better. We can’t wait to see what you come up with! 🌟

[quest-bot[bot]]

New Quest!

A new Quest has been launched in @permitio’s repo. Merge a PR that solves this issue to loot the Quest and earn your reward.

---

Loot of 250 USD has been stashed in this issue to reward the solver!

🗡 Comment @quest-bot embark to check-in for this Quest and start solving the issue. Other solvers will be notified!

⚔️ When you submit a PR, comment @quest-bot loot #5 to link your PR to this Quest.

Questions? Check out the docs.

[Mohiit70]

@quest-bot embark

[quest-bot[bot]]

@Mohiit70 has embarked on their Quest. 🗡

• @Mohiit70 has been on GitHub since 2022.
• They have merged 21 public PRs in that time.
• Their swords are blessed with JavaScript and CSS magic ✨
• They haven't contributed to this repo before.

This is not an assignment to the issue. Please check the repo’s contribution guidelines before submitting a PR.

Questions? Check out the docs.

[Yordaniss]

@quest-bot embark

Hey @gemanor

When I use a CLI in any application, I value three key aspects:

• Minimal installation requirements
• Usability
• Effective debugging (especially when errors occur)

With these in mind, I would suggest the following improvements:

1. Command Auto-Completion & Suggestions

How It Works:

Adds support for auto-completion, allowing the CLI to complete commands and options as users type. For instance, typing permit r could auto-expand to permit roles list, while incomplete commands like permit role suggest subcommands.

Value for Users:

• Reduced Typing: Saves time by minimizing command entry.
• Error Prevention: Prevents typos and syntax errors, making commands more reliable.
• Discoverability: Shows available commands in real-time, making exploration easier for new users.

2. Local Debugging with Verbose Logging

How It Works:

Adding a --verbose flag to each CLI command provides detailed logs for operations, including request details, response codes, error messages, execution times, and processing information. Running permit roles list --verbose could, for example, display API call details and parsing steps.

Value for Users:

• Troubleshooting: Helps users diagnose issues locally, useful when configurations don’t behave as expected.
• Transparency: Provides visibility into each step, building user confidence and understanding of how the CLI interacts with the Permit.io platform.
• Support Information: Verbose logs offer useful data for support, speeding up issue resolution.

3. Init Configuration

How It Works:

Configuration Setup: permit init prompts users for essential info (e.g., API keys, environment selection) and automatically creates or updates a configfile. For Windows, it could also add Permit CLI to the PATH, enabling global command usage. For other OSes, it could generate tailored instructions or scripts.

Value for Users:

• Simplified Setup: Reduces configuration time, especially beneficial for new users.
• Immediate Usability: With environment variables set, users can start using the CLI without extra steps.

I hope you find my ideas well

[quest-bot[bot]]

@Yordaniss has embarked on their Quest. 🗡

• @Yordaniss has been on GitHub since 2020.
• They have merged 25 public PRs in that time.
• Their swords are blessed with JavaScript and CSS magic ✨
• They haven't contributed to this repo before.

This is not an assignment to the issue. Please check the repo’s contribution guidelines before submitting a PR.

Questions? Check out the docs.