rockcarver / frodo

ForgeROckDO - the one cli to rule them all

Frodo - ForgeROck DO

Welcome to the Frodo (ForgeROck DO) project. Frodo is a JavaScript library and an accompanying command line interface (CLI) to manage ForgeRock platform deployments. Frodo supports Identity Cloud tenants, ForgeOps deployments, and classic deployments.

	Frodo CLI	Frodo Library
	Command Line Interface to manage ForgeRock platform deployments supporting Identity Cloud tenants, ForgeOps deployments, and classic deployments. Frodo CLI is the right tool for you if you want to manage ForgeRock deployments from the command line: Export and import your trees/journeys, scripts, and other configuration but you are not planning on writing your own code except for maybe automating the process using shell scripting or CI/CD tooling.	JavaScript Library to manage ForgeRock Identity Cloud tenants, ForgeOps deployments, and classic deployments. Frodo Library powers Frodo CLI, the command line tool to manage ForgeRock deployments. Frodo Library is the right tool for you if you want to write your own tooling to automate ForgeRock platform deployments.
Repo & Doc	frodo-cli	frodo-lib
Releases	Latest Architecture (v0.11.1 and newer) NPM GitHub (source and binaries) Legacy Architecture (v0.10.4 and older) GitHub (source and binaries)	Latest Architecture (v0.11.1 and newer) NPM GitHub (source)
Install	If you want to use the CLI but do not intend to develop or contribute to frodo, please refer to the Quick Start guide to get up and running in minutes.	If you are a node developer and want to use `frodo-lib` as a library for your own applications, follow these instructions.
Issues	Request cli features and report issues	Request library features and report issues
Highlights	Frodo allows an administrator to easily connect to and manage any number of Identity Cloud tenants, ForgeOps deployment instances, or classic deployment instances from the command line. The following tasks are currently supported: User mode Install and run pre-compiled single-file binaries - without any dependencies - for MacOS, Windows, and Linux. Manage journeys/trees Export, import and pruning of journeys. Frodo handles referenced scripts and email templates. Manage applications List, export, and import applications (OAuth2 clients). Manage connection profiles Saving and reading credentials (for multiple ForgeRock deployments) from a configuration file. Manage email templates List, export, and import email templates. Manage IDM configuration Export of IDM configuration. Import is coming. Print versions and tokens Obtain ForgeRock session token and admin access_tokens for a ForgeRock Identity Cloud or platform (ForgeOps) deployment View Identity Cloud logs List available log sources and tail them. Manage realms List realms and show realm details. Allow adding and removing of custom DNS names. Manage scripts List, export, and import scripts. Manage Identity Cloud environment specific variables and secrets List and view details of secrets and variables in Identity Cloud. Platform admin tasks Common tasks administrators need to perform daily that are tedious and repetitive. Advanced tasks, which used to be involved and potentially dangerous if performed manually, now made easy and safe. Create an oauth2 client with admin privileges. Get an access token using client credentials grant type. List oauth2 clients with admin privileges. Grant an oauth2 client admin privileges. Revoke admin privileges from an oauth2 client. List oauth2 clients with custom privileges. List all subjects of static user mappings that are not oauth2 clients. Remove a subject's static user mapping. Add AutoId static user mapping to enable dashboards and other AutoId-based functionality. Hide generic extension attributes. Show generic extension attributes. Repair org model (beta). Developer mode Install and run in developer mode (npm i -g)
Contributing	Help us improve the Frodo CLI	Join the effort to create the best library for ForgeRock platform management
Maintaining	Info for Frodo CLI maintainers	Info for Frodo Library maintainers