Display Permit's ReBAC Graph

[gemanor]

We want the CLI to be able to read the whole resource instance, relationships, and role assignment from the Permit APIs and display them as a graph with the relationship. Before attempting this issue, please propose your way to implement it (could be native CLI, could be opened in the browser, etc.)

Acceptance criteria:

• The command permit fga graph is showing the graph of the Permit permissions in ReBAC

[gemanor]

/bounty 200

[algora-pbc]

💎 $200 bounty • Permit.io

Steps to solve:

1. Start working: Comment /attempt #16 with your implementation plan
2. Submit work: Create a pull request including /claim #16 in the PR body to claim the bounty
3. Receive payment: 100% of the bounty is received 2-5 days post-reward. Make sure you are eligible for payouts

Thank you for contributing to permitio/permit-cli!

Add a bounty • Share on socials

Attempt	Started (GMT+0)	Solution
🟢 @harshtech123	Oct 29, 2024, 6:20:58 AM	WIP
🟢 @vishwamartur		#41

[harshtech123]

/attempt #16
Implementation Plan: Display Permit's ReBAC Graph

Purpose: The permit_fga_graph command would retrieve and display a visual graph representing the relationships and permissions across resource instances, role assignments, and other relevant entities using Permit’s API.

implementation Outline:

i like to proceed with CLI-based Option:
1 Data Retrieval
we will extend api.ts to include methods for fetching resource instances, roles, and relationships from the Permit API.

2 Graph Data Structuring
willing to Create the permit_fga_graph command to fetch data from the API, process it, and display it in a graph format.

3 Integrate with CLI Output
Purpose: Register the permit fga graph command to be accessible from the main CLI.

Options

• Cancel my attempt

[gemanor]

Hey @harshtech123, please read the issue description next time; we asked to propose a way of building it before submitting a PR.

In your PR:

1. You're not using the Pastel way to add commands. Read the Pastel docs and implement it correctly.
2. You should use the token from the keystone (look at the permit login command
3. We want to display visualize graph and not just print JSON. The graphs can be generated as HTML and opened in the browser, or alternatively, get interactively displayed in the CLI

[harshtech123]

@gemanor
on it

[harshtech123]

@gemanor please let me know how we can future improve it , (i am thinking about adding a option for token) so user can either parse it with loadauthtoken or manually pass as an option.

[vishwamartur]

/attempt #16

[algora-pbc]

@vishwamartur: We appreciate your enthusiasm but since you already have 3 active bounty attempts, we're going to keep this open for other contributors to attempt. 🫡