{"id":40503263,"url":"https://github.com/rockcarver/frodo-cli","last_synced_at":"2026-04-08T05:02:14.131Z","repository":{"id":56858612,"uuid":"525520670","full_name":"rockcarver/frodo-cli","owner":"rockcarver","description":"A CLI to manage ForgeRock platform deployments supporting Identity Cloud tenants, ForgeOps deployments, and classic deployments. ","archived":false,"fork":false,"pushed_at":"2026-03-30T21:34:22.000Z","size":47976,"stargazers_count":25,"open_issues_count":46,"forks_count":28,"subscribers_count":5,"default_branch":"main","last_synced_at":"2026-04-02T23:52:18.848Z","etag":null,"topics":["am","cicd","cli","devops","export","forgeops","forgerock","identity-cloud","idm","import","openam","openidm"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/rockcarver.png","metadata":{"files":{"readme":".github/README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2022-08-16T19:44:47.000Z","updated_at":"2026-03-30T21:34:25.000Z","dependencies_parsed_at":"2023-10-25T04:27:22.464Z","dependency_job_id":"7c0f567f-ca8c-490a-bdf7-316afc7488e9","html_url":"https://github.com/rockcarver/frodo-cli","commit_stats":{"total_commits":1664,"total_committers":20,"mean_commits":83.2,"dds":"0.46814903846153844","last_synced_commit":"e20528f4e616b582c1eaac160986d0d132d87631"},"previous_names":[],"tags_count":350,"template":false,"template_full_name":null,"purl":"pkg:github/rockcarver/frodo-cli","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rockcarver%2Ffrodo-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rockcarver%2Ffrodo-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rockcarver%2Ffrodo-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rockcarver%2Ffrodo-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rockcarver","download_url":"https://codeload.github.com/rockcarver/frodo-cli/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rockcarver%2Ffrodo-cli/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31540826,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-07T16:28:08.000Z","status":"online","status_checked_at":"2026-04-08T02:00:06.127Z","response_time":54,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["am","cicd","cli","devops","export","forgeops","forgerock","identity-cloud","idm","import","openam","openidm"],"created_at":"2026-01-20T19:12:11.535Z","updated_at":"2026-04-08T05:02:14.086Z","avatar_url":"https://github.com/rockcarver.png","language":"JavaScript","readme":"\u003c!-- README.md for GitHub; the one for NPM is ../README.md. --\u003e\n\n# Frodo CLI (@rockcarver/frodo-cli) - Export, import, and manage PingOne Advanced Identity Cloud configuration\n\nA command line interface to manage PingOne Advanced Identity Cloud environments, ForgeOps deployments, and classic deployments. Frodo-cli is powered by [frodo-lib](https://github.com/rockcarver/frodo-lib), a hybrid (ESM and CJS) library to manage PingOne Advanced Identity Cloud environments, ForgeOps deployments, and classic deployments.\n\n## Quick Nav\n\n- [Quick start](#quick-start)\n- [New in 4.x](#new-in-4x)\n- [Considerations](#considerations)\n- [Installing](#installing)\n- [Usage](#usage)\n- [Request features or report issues](#feature-requests)\n- [Contributing](#contributing)\n- [Maintaining](#maintaining)\n\n## Quick start\n\n### For the impatient\n\n#### MacOS and Linux\n\nThe below steps install the latest unstable (next) version of the cli using homebrew:\n\n```console\n$ brew tap rockcarver/frodo-cli\n$ brew install frodo-cli-next\n$ frodo conn add https://openam-my-tenant.forgeblocks.com/am john.doe@company.com '5uP3r-53cr3t!'\n$ frodo info my-tenant\n$ frodo journey export .... # or whatever you need to use frodo for\n```\n\n#### Windows, MacOS, Linux\n\nDownload the platform specific binary archive from the [release page](https://github.com/rockcarver/frodo-cli/releases).\n\nDetailed [Installation](#installing) instructions below.\n\n## New In 4.x\n\n### Based on Frodo Library 4.x\n\n[Frodo Library 4.x](https://github.com/rockcarver/frodo-lib?tab=readme-ov-file#frodo-library-4x---rockcarverfrodo-lib) continually improves with more stabilty, more modules, token caching, automatic token refresh, better error handling, and more.\n\n### New and updated commands\n\n| Command                                          |  Since  | Description                                                            |\n| ------------------------------------------------ | :-----: | ---------------------------------------------------------------------- |\n| frodo admin                                      |  1.0.0  | Platform admin tasks.                                                  |\n| \u0026emsp;add-autoid-static-user-mapping             |  1.0.0  | Add AutoId static user mapping to enable dashboards.                   |\n| \u0026emsp;create-oauth2-client-with-admin-privileges |  1.0.0  | Create an oauth2 client with admin privileges.                         |\n| \u0026emsp;execute-rfc7523-authz-grant-flow           |  2.0.0  | Execute RFC7523 authorization grant flow.                              |\n| \u0026emsp;federation                                 |  1.0.0  | Manages admin federation configuration.                                |\n| \u0026emsp;generate-rfc7523-authz-grant-artefacts     |  2.0.0  | Generate RFC7523 authorization grant artefacts.                        |\n| \u0026emsp;get-access-token                           |  1.0.0  | Get an access token using client credentials grant type.               |\n| \u0026emsp;grant-oauth2-client-admin-privileges       |  1.0.0  | Grant an oauth2 client admin privileges.                               |\n| \u0026emsp;hide-generic-extension-attributes          |  1.0.0  | Hide generic extension attributes.                                     |\n| \u0026emsp;list-oauth2-clients-with-admin-privileges  |  1.0.0  | List oauth2 clients with admin privileges.                             |\n| \u0026emsp;list-oauth2-clients-with-custom-privileges |  1.0.0  | List oauth2 clients with custom privileges.                            |\n| \u0026emsp;list-static-user-mappings                  |  1.0.0  | List all subjects of static user mappings that are not oauth2 clients. |\n| \u0026emsp;remove-static-user-mapping                 |  1.0.0  | Remove a subject's static user mapping.                                |\n| \u0026emsp;repair-org-model                           |  1.0.0  | Repair org model.                                                      |\n| \u0026emsp;revoke-oauth2-client-admin-privileges      |  1.0.0  | Revoke admin privileges from an oauth2 client.                         |\n| \u0026emsp;show-generic-extension-attributes          |  1.0.0  | Show generic extension attributes.                                     |\n|                                                  |         |                                                                        |\n| frodo agent                                      |  1.0.0  | Manage agents.                                                         |\n| \u0026emsp;delete                                     |  1.0.0  | Delete agents.                                                         |\n| \u0026emsp;describe                                   |  1.0.0  | Describe agents.                                                       |\n| \u0026emsp;export                                     |  1.0.0  | Export agents.                                                         |\n| \u0026emsp;gateway / ig                               |  1.0.0  | Manage gateway agents.                                                 |\n| \u0026emsp;\u0026emsp;delete                               |  1.0.0  | Delete identity gateway agents.                                        |\n| \u0026emsp;\u0026emsp;describe                             |  1.0.0  | Describe gateway agents.                                               |\n| \u0026emsp;\u0026emsp;export                               |  1.0.0  | Export gateway agents.                                                 |\n| \u0026emsp;import                                     |  1.0.0  | Import gateway agents.                                                 |\n| \u0026emsp;list                                       |  1.0.0  | List gateway agents.                                                   |\n| \u0026emsp;import                                     |  1.0.0  | Import agents.                                                         |\n| \u0026emsp;java                                       |  1.0.0  | Manage java agents.                                                    |\n| \u0026emsp;\u0026emsp;delete                               |  1.0.0  | Delete java agents.                                                    |\n| \u0026emsp;\u0026emsp;describe                             |  1.0.0  | Describe java agents.                                                  |\n| \u0026emsp;\u0026emsp;export                               |  1.0.0  | Export java agents.                                                    |\n| \u0026emsp;\u0026emsp;import                               |  1.0.0  | Import java agents.                                                    |\n| \u0026emsp;\u0026emsp;list                                 |  1.0.0  | List java agents.                                                      |\n| \u0026emsp;list                                       |  1.0.0  | List agents.                                                           |\n| \u0026emsp;web                                        |  1.0.0  | Manage web agents.                                                     |\n| \u0026emsp;\u0026emsp;delete                               |  1.0.0  | Delete web agents.                                                     |\n| \u0026emsp;\u0026emsp;describe                             |  1.0.0  | Describe web agents.                                                   |\n| \u0026emsp;\u0026emsp;export                               |  1.0.0  | Export web agents.                                                     |\n| \u0026emsp;\u0026emsp;import                               |  1.0.0  | Import web agents.                                                     |\n| \u0026emsp;\u0026emsp;list                                 |  1.0.0  | List web agents.                                                       |\n|                                                  |         |                                                                        |\n| frodo authn                                      |  2.0.0  | Manage authentication settings.                                        |\n| \u0026emsp;describe                                   |  2.0.0  | Describe authentication settings.                                      |\n| \u0026emsp;export                                     |  2.0.0  | Export authentication settings.                                        |\n| \u0026emsp;import                                     |  2.0.0  | Import authentication settings.                                        |\n|                                                  |         |                                                                        |\n| frodo authz                                      |  1.0.0  | Manage authorization policies, policy sets, and resource types.        |\n| \u0026emsp;policy                                     |  1.0.0  | Manages authorization policies.                                        |\n| \u0026emsp;\u0026emsp;delete                               |  1.0.0  | Delete authorization policies.                                         |\n| \u0026emsp;\u0026emsp;describe                             |  1.0.0  | Describe authorization policies.                                       |\n| \u0026emsp;\u0026emsp;export                               |  1.0.0  | Export authorization policies.                                         |\n| \u0026emsp;\u0026emsp;import                               |  1.0.0  | Import authorization policies.                                         |\n| \u0026emsp;\u0026emsp;list                                 |  1.0.0  | List authorization policies.                                           |\n| \u0026emsp;set / policyset                            |  1.0.0  | Manage authorization policy sets.                                      |\n| \u0026emsp;\u0026emsp;delete                               |  1.0.0  | Delete authorization policy sets.                                      |\n| \u0026emsp;\u0026emsp;describe                             |  1.0.0  | Describe authorization policy sets.                                    |\n| \u0026emsp;\u0026emsp;export                               |  1.0.0  | Export authorization policy sets.                                      |\n| \u0026emsp;\u0026emsp;import                               |  1.0.0  | Import authorization policy sets.                                      |\n| \u0026emsp;\u0026emsp;list                                 |  1.0.0  | List authorization policy sets.                                        |\n| \u0026emsp;type                                       |  1.0.0  | Manage authorization resource types.                                   |\n| \u0026emsp;\u0026emsp;delete                               |  1.0.0  | Delete authorization resource types.                                   |\n| \u0026emsp;\u0026emsp;describe                             |  1.0.0  | Describe authorization resource types.                                 |\n| \u0026emsp;\u0026emsp;export                               |  1.0.0  | Export authorization resource types.                                   |\n| \u0026emsp;\u0026emsp;import                               |  1.0.0  | Import authorization resource types.                                   |\n| \u0026emsp;\u0026emsp;list                                 |  1.0.0  | List authorization resource types.                                     |\n|                                                  |         |                                                                        |\n| frodo app / application                          |  2.0.0  | Old `app` renamed to `oauth`! Manage applications.                     |\n| \u0026emsp;delete                                     |  2.0.0  | Delete applications.                                                   |\n| \u0026emsp;export                                     |  2.0.0  | Export applications.                                                   |\n| \u0026emsp;import                                     |  2.0.0  | Import applications.                                                   |\n| \u0026emsp;list                                       |  2.0.0  | List applications.                                                     |\n| frodo config                                     |  2.0.0  | Manage full cloud configuration.                                       |\n| \u0026emsp;export                                     |  2.0.0  | Export full cloud configuration.                                       |\n| \u0026emsp;import                                     |  2.0.0  | Import full cloud configuration.                                       |\n|                                                  |         |                                                                        |\n| frodo config-manager                             | `4.0.0` | Manage cloud configuration using fr-config-manager.                    |\n| \u0026emsp;pull                                       | `4.0.0` | Export cloud configuration using fr-config-manager.                    |\n| \u0026emsp;\u0026emsp;access-config                        | `4.0.0` | Export access-config objects.                                          |\n| \u0026emsp;\u0026emsp;all                                  | `4.0.0` | Export all config.                                                     |\n| \u0026emsp;\u0026emsp;all-static                           | `4.0.0` | Export all static config.                                              |\n| \u0026emsp;\u0026emsp;audit                                | `4.0.0` | Export audit objects.                                                  |\n| \u0026emsp;\u0026emsp;authentication                       | `4.0.0` | Export authentication objects.                                         |\n| \u0026emsp;\u0026emsp;authz-policies                       | `4.0.0` | Export authorization policies from realm.                              |\n| \u0026emsp;\u0026emsp;connector-definitions                | `4.0.0` | Export aconnector definitions.                                         |\n| \u0026emsp;\u0026emsp;connector-mappings                   | `4.0.0` | Export connector mappings.                                                |\n| \u0026emsp;\u0026emsp;cookie-domains                       | `4.0.0` | Export cookie-domains objects.                                         |\n| \u0026emsp;\u0026emsp;cors                                 | `4.0.0` | Export CORS configuration.                                             |\n| \u0026emsp;\u0026emsp;csp                                  | `4.0.0` | Export content security policy.                                        |\n| \u0026emsp;\u0026emsp;email-provider                       | `4.0.0` | Export email provider configuration.                                   |\n| \u0026emsp;\u0026emsp;email-templates                      | `4.0.0` | Export email-templates objects.                                        |\n| \u0026emsp;\u0026emsp;endpoints                            | `4.0.0` | Export custom endpoints objects.                                       |\n| \u0026emsp;\u0026emsp;internal-roles                       | `4.0.0` | Export internal roles.                                                 |\n| \u0026emsp;\u0026emsp;journeys                             | `4.0.0` | Export journeys.                                                       |\n| \u0026emsp;\u0026emsp;kba                                  | `4.0.0` | Export kba-config objects.                                             |\n| \u0026emsp;\u0026emsp;locales                              | `4.0.0` | Export custom locales objects.                                         |\n| \u0026emsp;\u0026emsp;managed-objects                      | `4.0.0` | Export managed-objects.                                                |\n| \u0026emsp;\u0026emsp;oauth2-agents                        | `4.0.0` | Export OAuth2 Agents                                                   |\n| \u0026emsp;\u0026emsp;org-privileges                       | `4.0.0` | Export organization privileges config.                                 |\n| \u0026emsp;\u0026emsp;password-policy                      | `4.0.0` | Export password-policy objects.                                        |\n| \u0026emsp;\u0026emsp;raw                                  | `4.0.0` | Export raw configurations from the tenant.                             |\n| \u0026emsp;\u0026emsp;remote-servers                       | `4.0.0` | Export remote-servers objects.                                         |\n| \u0026emsp;\u0026emsp;saml                                 | `4.0.0` | Export saml.                                                           |\n| \u0026emsp;\u0026emsp;schedules                            | `4.0.0` | Export schedules.                                                      |\n| \u0026emsp;\u0026emsp;scripts                              | `4.0.0` | Export authorization scripts.                                          |\n| \u0026emsp;\u0026emsp;secret-mappings                      | `4.0.0` | Export secret mappings.                                                |\n| \u0026emsp;\u0026emsp;secrets                              | `4.0.0` | Export secrets.                                                        |\n| \u0026emsp;\u0026emsp;service-objects                      | `4.0.0` | Export service objects.                                                |\n| \u0026emsp;\u0026emsp;services                             | `4.0.0` | Export authentication services.                                        |\n| \u0026emsp;\u0026emsp;terms-and-conditions                 | `4.0.0` | Export terms and conditions.                                           |\n| \u0026emsp;\u0026emsp;test                                 | `4.0.0` | Test connection and authentication.                                    |\n| \u0026emsp;\u0026emsp;themes                               | `4.0.0` | Export themes.                                                         |\n| \u0026emsp;\u0026emsp;ui-config                            | `4.0.0` | Export ui-configuration objects.                                       |\n| \u0026emsp;\u0026emsp;variables                            | `4.0.0` | Export variables objects.                                              |\n|                                                  |         |                                                                        |\n| frodo conn / connection                          |  1.0.0  | Manage connection profiles.                                            |\n| \u0026emsp;delete                                     |  1.0.0  | Delete connection profiles.                                            |\n| \u0026emsp;describe                                   |  1.0.0  | Describe connection profile.                                           |\n| \u0026emsp;list                                       |  1.0.0  | List connection profiles.                                              |\n| \u0026emsp;save / add                                 |  1.0.0  | Save connection profiles.                                              |\n|                                                  |         |                                                                        |\n| frodo email                                      |  1.0.0  | Manage email templates and configuration.                              |\n| \u0026emsp;template                                   |  1.0.0  | Manage email templates.                                                |\n| \u0026emsp;\u0026emsp;delete                               |  3.1.0  | Delete email templates.                                                |\n| \u0026emsp;\u0026emsp;export                               |  1.0.0  | Export email templates.                                                |\n| \u0026emsp;\u0026emsp;import                               |  1.0.0  | Import email templates.                                                |\n| \u0026emsp;\u0026emsp;list                                 |  1.0.0  | List email templates.                                                  |\n|                                                  |         |                                                                        |\n| frodo esv                                        |  1.0.0  | Manage environment secrets and variables (ESVs).                       |\n| \u0026emsp;apply                                      |  1.0.0  | Apply pending changes to secrets and variables.                        |\n| \u0026emsp;secret                                     |  1.0.0  | Manages secrets.                                                       |\n| \u0026emsp;\u0026emsp;create                               |  1.0.0  | Create secrets.                                                        |\n| \u0026emsp;\u0026emsp;delete                               |  1.0.0  | Delete secrets.                                                        |\n| \u0026emsp;\u0026emsp;describe                             |  1.0.0  | Describe secrets.                                                      |\n| \u0026emsp;\u0026emsp;export                               |  2.0.0  | Export secrets.                                                        |\n| \u0026emsp;\u0026emsp;import                               |  2.0.0  | Import secrets.                                                        |\n| \u0026emsp;\u0026emsp;list                                 |  1.0.0  | List secrets.                                                          |\n| \u0026emsp;\u0026emsp;set                                  |  1.0.0  | Set secret description.                                                |\n| \u0026emsp;\u0026emsp;version                              |  1.0.0  | Manage secret versions.                                                |\n| \u0026emsp;variable                                   |  1.0.0  | Manage variables.                                                      |\n| \u0026emsp;\u0026emsp;create                               |  1.0.0  | Create variables.                                                      |\n| \u0026emsp;\u0026emsp;delete                               |  1.0.0  | Delete variables.                                                      |\n| \u0026emsp;\u0026emsp;describe                             |  1.0.0  | Describe variables.                                                    |\n| \u0026emsp;\u0026emsp;export                               |  2.0.0  | Export variables.                                                      |\n| \u0026emsp;\u0026emsp;import                               |  2.0.0  | Import variables.                                                      |\n| \u0026emsp;\u0026emsp;list                                 |  1.0.0  | List variables.                                                        |\n| \u0026emsp;\u0026emsp;set                                  |  1.0.0  | Set variable description.                                              |\n|                                                  |         |                                                                        |\n| frodo idm                                        |  1.0.0  | Manage IDM configuration.                                              |\n| \u0026emsp;count                                      |  1.0.0  | Count managed objects.                                                 |\n| \u0026emsp;export                                     |  1.0.0  | Export IDM configuration objects.                                      |\n| \u0026emsp;import                                     |  1.0.0  | Import IDM configuration objects.                                      |\n| \u0026emsp;list                                       |  1.0.0  | List IDM configuration objects.                                        |\n|                                                  |         |                                                                        |\n| frodo idp                                        |  1.0.0  | Manage (social) identity providers.                                    |\n| \u0026emsp;export                                     |  1.0.0  | Export (social) identity providers.                                    |\n| \u0026emsp;import                                     |  1.0.0  | Import (social) identity providers.                                    |\n| \u0026emsp;list                                       |  1.0.0  | List (social) identity providers.                                      |\n|                                                  |         |                                                                        |\n| frodo info                                       |  1.0.0  | Print versions and tokens.                                             |\n|                                                  |         |                                                                        |\n| frodo journey                                    |  1.0.0  | Manage journeys/trees.                                                 |\n| \u0026emsp;delete                                     |  1.0.0  | Delete journeys/trees.                                                 |\n| \u0026emsp;describe                                   |  1.0.0  | Describe journeys/trees.                                               |\n| \u0026emsp;disable                                    |  1.0.0  | Disable journeys/trees.                                                |\n| \u0026emsp;enable                                     |  1.0.0  | Enable journeys/trees.                                                 |\n| \u0026emsp;export                                     |  1.0.0  | Export journeys/trees.                                                 |\n| \u0026emsp;import                                     |  1.0.0  | Import journey/tree.                                                   |\n| \u0026emsp;list                                       |  1.0.0  | List journeys/trees.                                                   |\n| \u0026emsp;prune                                      |  1.0.0  | Prune orphaned configuration artifacts.                                |\n|                                                  |         |                                                                        |\n| frodo log / logs                                 |  1.0.0  | List/View Identity Cloud logs                                          |\n| \u0026emsp;fetch                                      |  1.0.0  | Fetch Identity Cloud logs.                                             |\n| \u0026emsp;key                                        |  1.0.0  | Manage Identity Cloud log API keys.                                    |\n| \u0026emsp;list                                       |  1.0.0  | List available ID Cloud log sources.                                   |\n| \u0026emsp;tail                                       |  1.0.0  | Tail Identity Cloud logs.                                              |\n|                                                  |         |                                                                        |\n| frodo mapping                                    |  2.0.0  | Manage IDM mappings.                                                   |\n| \u0026emsp;delete                                     |  2.0.0  | Delete IDM mappings.                                                   |\n| \u0026emsp;export                                     |  2.0.0  | Export IDM mappings.                                                   |\n| \u0026emsp;import                                     |  2.0.0  | Import IDM mappings.                                                   |\n| \u0026emsp;list                                       |  2.0.0  | List IDM mappings.                                                     |\n| \u0026emsp;rename                                     |  2.0.0  | Renames mappings from legacy to new naming scheme.                     |\n|                                                  |         |                                                                        |\n| frodo node                                       | `4.0.0` | Manage custom nodes.                                                   |\n| \u0026emsp;delete                                     | `4.0.0` | Delete custom nodes.                                                   |\n| \u0026emsp;describe                                   | `4.0.0` | Delete custom nodes.                                                   |\n| \u0026emsp;export                                     | `4.0.0` | Export custom nodes.                                                   |\n| \u0026emsp;import                                     | `4.0.0` | Import custom nodes.                                                   |\n| \u0026emsp;list                                       | `4.0.0` | List custom nodes.                                                     |\n|                                                  |         |                                                                        |\n| frodo oauth                                      |  2.0.0  | Renamed from `app`! Manage OAuth2 clients and providers.               |\n| \u0026emsp;client                                     |  2.0.0  | Manage OAuth2 clients.                                                 |\n| \u0026emsp;\u0026emsp;export                               |  2.0.0  | Export OAuth2 clients.                                                 |\n| \u0026emsp;\u0026emsp;import                               |  2.0.0  | Import OAuth2 clients.                                                 |\n| \u0026emsp;\u0026emsp;list                                 |  2.0.0  | List OAuth2 clients.                                                   |\n|                                                  |         |                                                                        |\n| frodo realm                                      |  1.0.0  | Manage realms.                                                         |\n| \u0026emsp;add-custom-domain                          |  1.0.0  | Add custom domain (realm DNS alias).                                   |\n| \u0026emsp;describe / details                         |  1.0.0  | Describe realms.                                                       |\n| \u0026emsp;list                                       |  1.0.0  | List realms.                                                           |\n| \u0026emsp;remove-custom-domain                       |  1.0.0  | Remove custom domain (realm DNS alias).                                |\n|                                                  |         |                                                                        |\n| frodo saml                                       |  1.0.0  | Manage SAML entity providers and circles of trust.                     |\n| \u0026emsp;cot                                        |  1.0.0  | Manage circles of trust.                                               |\n| \u0026emsp;\u0026emsp;export                               |  1.0.0  | Export SAML circles of trust.                                          |\n| \u0026emsp;\u0026emsp;import                               |  1.0.0  | Import SAML circles of trust.                                          |\n| \u0026emsp;\u0026emsp;list                                 |  1.0.0  | List SAML circles of trust.                                            |\n| \u0026emsp;delete                                     |  1.0.0  | Delete SAML entity providers.                                          |\n| \u0026emsp;describe                                   |  1.0.0  | Describe the configuration of an entity provider.                      |\n| \u0026emsp;export                                     |  1.0.0  | Export SAML entity providers.                                          |\n| \u0026emsp;import                                     |  1.0.0  | Import SAML entity providers.                                          |\n| \u0026emsp;list                                       |  1.0.0  | List SAML entity providers.                                            |\n| \u0026emsp;metadata                                   |  1.0.0  | SAML metadata operations.                                              |\n| \u0026emsp;\u0026emsp;export                               |  1.0.0  | Export metadata.                                                       |\n|                                                  |         |                                                                        |\n| frodo script                                     |  1.0.0  | Manage scripts.                                                        |\n| \u0026emsp;delete                                     |  1.0.0  | Delete scripts.                                                        |\n| \u0026emsp;export                                     |  1.0.0  | Export scripts.                                                        |\n| \u0026emsp;import                                     |  1.0.0  | Import scripts.                                                        |\n| \u0026emsp;list                                       |  1.0.0  | List scripts.                                                          |\n|                                                  |         |                                                                        |\n| frodo service                                    |  1.0.0  | Manage AM services.                                                    |\n| \u0026emsp;delete                                     |  1.0.0  | Delete AM services.                                                    |\n| \u0026emsp;export                                     |  1.0.0  | Export AM services.                                                    |\n| \u0026emsp;import                                     |  1.0.0  | Import AM services.                                                    |\n| \u0026emsp;list                                       |  1.0.0  | List AM services.                                                      |\n|                                                  |         |                                                                        |\n| frodo shell                                      |  2.0.0  | Launch the frodo interactive shell.                                    |\n|                                                  |         |                                                                        |\n| frodo theme                                      |  1.0.0  | Manage themes.                                                         |\n| \u0026emsp;delete                                     |  1.0.0  | Delete themes.                                                         |\n| \u0026emsp;export                                     |  1.0.0  | Export themes.                                                         |\n| \u0026emsp;import                                     |  1.0.0  | Import themes.                                                         |\n| \u0026emsp;list                                       |  1.0.0  | List themes.                                                           |\n|                                                  |         |                                                                        |\n| frodo help                                       |  1.0.0  | display help for command                                               |\n\n### Global support for `-D`, `--directory` to set the working directory\n\n2.x globally supports `-D`, `--directory` to specify the working directory for any command that interacts with the file system, typically `export` and `import` sub-commands. 1.x did only allow to specify a working directory for the `idm` command. Frodo combines `-D` and `-f` into a single path, assuming `-f` to be a relative path to `-D` and `-D` defaulting to `.`, the current directory:\n\nTo import the file `/absolute/path/to/working/directory/relative/path/to/file.variable.json`, one could construct any of the following commands:\n\n```console\nfrodo esv variable export -f /absolute/path/to/working/directory/sub-path/to/file.variable.json \u003cmy-env\u003e\nfrodo esv variable export -D /absolute/path/to/working/directory/sub-path/to  -f file.variable.json \u003cmy-env\u003e\nfrodo esv variable export -D /absolute/path/to/working/directory -f sub-path/to/file.variable.json \u003cmy-env\u003e\n```\n\nAlternatively, to import the file `/relative/path/to/working/directory/relative/path/to/file.variable.json`, one could construct any of the following commands:\n\n```console\nfrodo esv variable export -f relative/path/to/working/directory/sub-path/to/file.variable.json \u003cmy-env\u003e\nfrodo esv variable export -D relative/path/to/working/directory/sub-path/to  -f file.variable.json \u003cmy-env\u003e\nfrodo esv variable export -D relative/path/to/working/directory -f sub-path/to/file.variable.json \u003cmy-env\u003e\n```\n\n### Secure Token Caching\n\nFrodo CLI 2.x uses a secure token cache, which is active by default. The cache is tokenized and encrypted on disk, so it persists across CLI executions, dramatically decreasing authentication and token requests. You can disable the cache by either using the `--no-cache` option or by setting the `FRODO_NO_CACHE` environment variable.\nYou can change the default location of the cache file (`~/.frodo/TokenCache.json`) by setting the `FRODO_TOKEN_CACHE_PATH` environment variable.\n\n### Automatic Token Refresh\n\nFrodo CLI 2.x automatically refreshes session and access tokens before they expire. Combined with the new token cache, the CLI maintains a set of valid tokens at all times.\n\n## Considerations\n\n### Platform Passwords And Secrets\n\nPlatform passwords and secrets are configuration values that are stored encrypted as part of platform configuration. Examples are oauth2 client secrets or service account passwords.\n\nFrodo generally doesn't export platform passwords and secrets. The platform supports configuration placeholders and environment secrets and variables allowing administrators to separate the functional configuration from sensitive secrets and variable configuration values. `frodo` assumes administrators take full advantage of these capabilities so that there is no need or expectation that exports include passwords and secrets. However, where the APIs support it, administrators can seed import data with raw secrets and `frodo` will import them.\n\n### Advanced Identity Cloud Environment Secrets And Variables (ESVs)\n\nFrodo supports exporting and importing of ESV secret values. To leave stuartship of secret values with the cloud environment where they belong, frodo always encrypts values using either encryption keys from the source environment (default) or the target environment. Frodo never exports secrets in the clear.\n\n## Installing\n\n### Download executable binaries (all supported platforms)\n\nDownload the platform specific binary archive from the [release page](https://github.com/rockcarver/frodo-cli/releases).\n\n### Homebrew (preferred for MacOS [x86 and M1] and Linux)\n\n1. Make sure you have a working [homebrew](https://brew.sh/).\n2. [Tap](https://docs.brew.sh/Taps) the custom formula as below:\n\n```console\n$ brew tap rockcarver/frodo-cli\n==\u003e Tapping rockcarver/frodo-cli\nCloning into '/opt/homebrew/Library/Taps/rockcarver/homebrew-frodo-cli'...\nremote: Enumerating objects: 8, done.\n.\n.\n```\n\n3. Once its tapped, you can install either the STABLE major version or the latest/unstable (next) version, as below\n\nSTABLE\n\n```console\n$ brew install frodo-cli\n==\u003e Fetching rockcarver/frodo-cli/frodo-cli\n==\u003e Cloning https://github.com/rockcarver/frodo-cli.git\n.\n.\n```\n\nOr latest/unstable (next)\n\n```console\n$ brew install frodo-cli-next\n==\u003e Fetching rockcarver/frodo-cli/frodo-cli-next\n==\u003e Cloning https://github.com/rockcarver/frodo-cli.git\n.\n.\n```\n\nTo verify the installation, run `frodo -v`, it should print something like:\n\n```console\n$ frodo -v\nYou are running the binary release.\nInstalled versions:\ncli: v2.0.0-43\nlib: v2.0.0-59\nnode: v18.18.2\n```\n\nIf you have the STABLE version installed and you want to get the latest, do:\n\n```console\n$ brew uninstall frodo-cli\n$ brew install frodo-cli-next\n```\n\nOr vice-versa.\n\nTo upgrade to latest frodo\n\n```console\n$ brew upgrade frodo-cli\n==\u003e Upgrading 1 outdated package:\nrockcarver/frodo-cli/frodo-cli-next 2.0.0-43 -\u003e 2.0.0-44\n==\u003e Fetching rockcarver/frodo-cli/frodo-cli-next\n==\u003e Cloning https://github.com/rockcarver/frodo-cli.git\nUpdating /Users/sandeep.chaturvedi/Library/Caches/Homebrew/frodo-cli-next--git\nFrom https://github.com/rockcarver/frodo-cli\n * [new tag]           v2.0.0-44  -\u003e v2.0.0-44\n==\u003e Checking out tag v2.0.0-44\nPrevious HEAD position was 9a968346 Updated changelog and version for release v2.0.0-43\nHEAD is now at e687fdf6 Updated changelog and version for release v2.0.0-44\nHEAD is now at e687fdf6 Updated changelog and version for release v2.0.0-44\n==\u003e Upgrading rockcarver/frodo-cli/frodo-cli-next\n  2.0.0-43 -\u003e 2.0.0-44\n```\n\n### NPM package\n\nIf you are a node developer and want to use frodo as a cli tool or as a library for your own applications, you can install the npm package:\n\n- To install (or update to) the latest version as a cli tool:\n  ```console\n  npm i -g @rockcarver/frodo-cli\n  ```\n- To install (or update to) the latest pre-release:\n  ```console\n  npm i @rockcarver/frodo-cli@next\n  ```\n\n## Usage\n\n### Connection Profiles\n\nA connection profile is a set of ForgeRock environment URL (Access Management base URL) and login credentials. For PingOne Advanced Identity Cloud connections, the profile also contains log API key and secret and service account id and jwk. Connection profiless are stored in `~/.frodo/.frodorc`. Passwords, secrets, and keys are encrypted.\n\nConnection profiles make it super easy to access your different environments securely. Follow these steps to get started:\n\n1. Run `frodo conn add` (example below) to setup `frodo` for your ForgeRock environment. If all parameters are correct, `frodo` creates a new [connection profile](#connection-profiles). If you are offline and don't want to validate the data you enter, you can use the --no-validate paramter and frodo stores the [connection profile](#connection-profiles) without validating it.\n\n   ```console\n   $ frodo conn add https://openam-my-tenant.forgeblocks.com/am john.doe@company.com '5uP3r-53cr3t!'\n   Connected to https://openam-my-tenant.forgeblocks.com/am [alpha] as user john.doe@company.com\n   Created and added service account Frodo-SA-1677517618855 with id af5eadc7-d59a-450a-967d-090b377b4eaf to profile.\n   Created log API key 7683791888e2c7740eb91abd988b65f7 and secret.\n   Saved connection profile https://openam-my-tenant.forgeblocks.com/am\n   ```\n\n2. Test your connection profile using the `frodo info` command:\n\n   ```console\n   $ frodo info my-tenant\n   Connected to https://openam-my-tenant.forgeblocks.com/am [alpha] as service account Frodo-SA-1677517618855 [af5eadc7-d59a-450a-967d-090b377b4eaf]\n\n   Host URL       │https://openam-my-tenant.forgeblocks.com/am\n   AM Version     │7.3.0-SNAPSHOT Build 3cee5f270ed80b0354b709e8685e2681617e9c5a (2023-February-06 13:57)\n   Subject (Type) │Frodo-SA-1677517618855 [af5eadc7-d59a-450a-967d-090b377b4eaf] (Service Account)\n   Deployment Type│cloud\n   Cookie Name    │27e1d6427df2a07\n   Immutable      │false\n   Locked         │false\n   Region         │us-west1\n   Tier           │other\n\n   Bearer token:\n   eyJ0eXAiOiJKV......\n   ```\n\n   Note how the command does not specify the complete tenant URL nor username nor password. It only needs a unique substring that matches the tenant URL and frodo looks up and uses the right [connection profile](#connection-profiles).\n\n3. Now you can use other frodo commands, like `journey`, `logs`, `applications` etc. as desired. **For detailed usage, refer to [this](#usage)**\n\nUse the `frodo conn` sub-commands to manage connections:\n\n- `frodo conn list` to list all the connections frodo currently knows about for the current machine and user.\n- `frodo conn save` or `frodo conn add` to save a new or update an existing connection profile.\n- `frodo conn describe` to see all the details of a connection profile.\n- `frodo conn delete` to remove a connection profile.\n\nOnce `frodo` saves a connection, you don't have to provide the full `host` or `username` and `password` arguments. You can reference your connection using any unique substring of your host URL. This is the most common way users would run frodo. For example, if `https://openam-example-use1-dev.id.forgerock.io/am` and `https://openam-example-use1-staging.id.forgerock.io/am` are two saved ForgeRock connections from previous commands, one would simply use:\n\n```console\nfrodo info example-use1-dev\n```\n\nOR\n\n```console\nfrodo info example-use1-staging\n```\n\n### cli options\n\nYou interact with `frodo` using commands and options. You can see the list of options by using the `help` command\n\n```console\nfrodo help\nUsage: frodo [options] [command]\n\nOptions:\n  -v, --version                                         output the version number\n  -h, --help                                            display help for command\n\nCommands:\n  admin                                                 Platform admin tasks.\n  agent                                                 Manage agents.\n  authn                                                 Manage authentication settings.\n  authz                                                 Manage authorization policies, policy sets, and resource types.\n  app                                                   Manage applications.\n  config                                                Manage full cloud configuration.\n  conn|connection                                       Manage connection profiles.\n  email                                                 Manage email templates and configuration.\n  esv                                                   Manage environment secrets and variables (ESVs).\n  idm                                                   Manage IDM configuration.\n  idp                                                   Manage (social) identity providers.\n  info [options] [host] [username] [password]           Print versions and tokens.\n  journey                                               Manage journeys/trees.\n  log|logs                                              List/View Identity Cloud logs\n  mapping                                               Manage IDM mappings.\n  oauth                                                 Manage OAuth2 clients and providers.\n  realm                                                 Manage realms.\n  saml                                                  Manage SAML entity providers and circles of trust.\n  script                                                Manage scripts.\n  service                                               Manage AM services.\n  shell [options] [host] [realm] [username] [password]  Launch the frodo interactive shell.\n  theme                                                 Manage themes.\n  help [command]                                        display help for command\n```\n\nOr to view options for a specific command\n\n```console\nfrodo journey help\nUsage: frodo journey [options] [command]\n\nManage journeys/trees.\n\nOptions:\n  -h, --help      Help\n\nCommands:\n  delete          Delete journeys/trees.\n  describe        If host argument is supplied, describe the journey/tree indicated by -t, or all journeys/trees in the realm if no\n                  -t is supplied, otherwise describe the journey/tree export file indicated by -f.\n  disable         Disable journeys/trees.\n  enable          Enable journeys/trees.\n  export          Export journeys/trees.\n  help [command]  display help for command\n  import          Import journeys/trees.\n  list            List journeys/trees.\n  prune           Prune orphaned configuration artifacts left behind after deleting authentication trees. You will be prompted\n                  before any destructive operations are performed.\n```\n\n```console\nfrodo journey help export\nUsage: frodo journey export [options] [host] [realm] [username] [password]\n\nExport journeys/trees.\n\nArguments:\n  host                         Access Management base URL, e.g.: https://cdk.iam.example.com/am. To use a connection profile, just specify a unique substring.\n  realm                        Realm. Specify realm as '/' for the root realm or 'realm' or '/parent/child' otherwise. (default: \"alpha\" for Identity Cloud tenants, \"/\" otherwise.)\n  username                     Username to login with. Must be an admin user with appropriate rights to manage authentication journeys/trees.\n  password                     Password.\n\nOptions:\n  -a, --all                    Export all the journeys/trees in a realm. Ignored with -i.\n  -A, --all-separate           Export all the journeys/trees in a realm as separate files \u003cjourney/tree name\u003e.json. Ignored with -i or -a.\n  --curlirize                  Output all network calls in curl format.\n  -D, --directory \u003cdirectory\u003e  Set the working directory.\n  --debug                      Debug output during command execution. If specified, may or may not produce additional output helpful for troubleshooting.\n  -f, --file \u003cfile\u003e            Name of the file to write the exported journey(s) to. Ignored with -A.\n  --flush-cache                Flush token cache.\n  -h, --help                   Help\n  -i, --journey-id \u003cjourney\u003e   Name of a journey/tree. If specified, -a and -A are ignored.\n  -k, --insecure               Allow insecure connections when using SSL/TLS. Has no effect when using a network proxy for https (HTTPS_PROXY=http://\u003chost\u003e:\u003cport\u003e), in that case the proxy must provide this capability. (default: Don't\n                               allow insecure connections)\n  -m, --type \u003ctype\u003e            Override auto-detected deployment type. Valid values for type:\n                               classic:  A classic Access Management-only deployment with custom layout and configuration.\n                               cloud:    A ForgeRock Identity Cloud environment.\n                               forgeops: A ForgeOps CDK or CDM deployment.\n                               The detected or provided deployment type controls certain behavior like obtaining an Identity Management admin token or not and whether to export/import referenced email templates or how to walk through the\n                               tenant admin login flow of Identity Cloud and handle MFA (choices: \"classic\", \"cloud\", \"forgeops\")\n  -N, --no-metadata            Does not include metadata in the export file.\n  --no-cache                   Disable token cache for this operation.\n  --no-coords                  Do not include the x and y coordinate positions of the journey/tree nodes.\n  --no-deps                    Do not include any dependencies (scripts, email templates, SAML entity providers and circles of trust, social identity providers, themes).\n  --sa-id \u003csa-id\u003e              Service account id.\n  --sa-jwk-file \u003cfile\u003e         File containing the JSON Web Key (JWK) associated with the the service account.\n  --use-string-arrays          Where applicable, use string arrays to store multi-line text (e.g. scripts). (default: off)\n  --verbose                    Verbose output during command execution. If specified, may or may not produce additional output.\n\nEnvironment Variables:\n  FRODO_HOST: Access Management base URL. Overrides 'host' argument.\n  FRODO_REALM: Realm. Overrides 'realm' argument.\n  FRODO_USERNAME: Username. Overrides 'username' argument.\n  FRODO_PASSWORD: Password. Overrides 'password' argument.\n  FRODO_SA_ID: Service account uuid. Overrides '--sa-id' option.\n  FRODO_SA_JWK: Service account JWK. Overrides '--sa-jwk-file' option but takes the actual JWK as a value, not a file name.\n  FRODO_NO_CACHE: Disable token cache. Same as '--no-cache' option.\n  FRODO_TOKEN_CACHE_PATH: Use this token cache file instead of '~/.frodo/TokenCache.json'.\n  FRODO_CONNECTION_PROFILES_PATH: Use this connection profiles file instead of '~/.frodo/Connections.json'.\n  FRODO_AUTHENTICATION_SERVICE: Name of a login journey to use.\n  FRODO_DEBUG: Set to any value to enable debug output. Same as '--debug'.\n  FRODO_MASTER_KEY_PATH: Use this master key file instead of '~/.frodo/masterkey.key' file.\n  FRODO_MASTER_KEY: Use this master key instead of what's in '~/.frodo/masterkey.key'. Takes precedence over FRODO_MASTER_KEY_PATH.\n```\n\n## Feature requests\n\nPlease use the repository's [issues](https://github.com/rockcarver/frodo-cli/issues) to request new features/enhancements or report bugs/issues.\n\n## Contributing\n\nIf you would like to contribute to frodo, please refer to the [contributing instructions](../docs/CONTRIBUTE.md).\n\n## Maintaining\n\nIf you are a maintainer of this repository, please refer to the [pipeline and release process instructions](../docs/PIPELINE.md).\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frockcarver%2Ffrodo-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frockcarver%2Ffrodo-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frockcarver%2Ffrodo-cli/lists"}