{"id":22808927,"url":"https://github.com/okta/okta-cli","last_synced_at":"2025-04-05T15:05:43.854Z","repository":{"id":37955322,"uuid":"199477028","full_name":"okta/okta-cli","owner":"okta","description":"Okta CLI [Beta] tools to help bootstrap new Okta organizations, and applications.","archived":false,"fork":false,"pushed_at":"2025-03-18T18:17:59.000Z","size":102910,"stargazers_count":91,"open_issues_count":49,"forks_count":26,"subscribers_count":14,"default_branch":"master","last_synced_at":"2025-03-29T14:06:38.196Z","etag":null,"topics":["beta","hacktoberfest"],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/okta.png","metadata":{"files":{"readme":"README.md","changelog":null,"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}},"created_at":"2019-07-29T15:15:43.000Z","updated_at":"2025-03-06T14:15:12.000Z","dependencies_parsed_at":"2023-09-26T22:01:21.122Z","dependency_job_id":"f65cf28a-1f14-4c79-b9f1-5cb756816666","html_url":"https://github.com/okta/okta-cli","commit_stats":{"total_commits":478,"total_committers":13,"mean_commits":36.76923076923077,"dds":0.5648535564853556,"last_synced_commit":"7ee30e0f3e9a21289638803a07d9545b0a72a407"},"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/okta%2Fokta-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/okta%2Fokta-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/okta%2Fokta-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/okta%2Fokta-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/okta","download_url":"https://codeload.github.com/okta/okta-cli/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247353731,"owners_count":20925329,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["beta","hacktoberfest"],"created_at":"2024-12-12T11:12:52.417Z","updated_at":"2025-04-05T15:05:43.823Z","avatar_url":"https://github.com/okta.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"[\u003cimg src=\"images/okta-cli-blink-min.svg\" align=\"right\" width=\"128px\"/\u003e](https://devforum.okta.com/)\n[![Maven Central](https://img.shields.io/maven-central/v/com.okta.cli/okta-cli?label=maven%20central%20[BETA]\u0026style=plastic)](https://search.maven.org/#search%7Cga%7C1%7Cg%3A%22com.okta.cli%22%20a%3A%22okta-cli%22)\n[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)\n\nOkta CLI\n========\n\nThe Okta CLI is the easiest way to get started with Okta! \n\nFor Java developers using Apache Maven, there's the [Okta Maven Plugin](https://github.com/oktadev/okta-maven-plugin). \n\n\u003ca href=\"https://foojay.io/today/works-with-openjdk\"\u003e\n   \u003cimg align=\"right\" \n        src=\"https://github.com/foojayio/badges/raw/main/works_with_openjdk/Works-with-OpenJDK.png\"   \n        width=\"100\"\u003e\n\u003c/a\u003e\n\n## Install the CLI\n\nFollow the directions for your platform to install the CLI. For more information on installing and using the CLI, see the [Okta CLI Documentation](https://cli.okta.com/).\n\n### macOS Using [Homebrew](https://brew.sh/)\n\nRun the following command in a terminal to install the CLI:\n\n```bash\nbrew install --cask oktadeveloper/tap/okta\n```\n\nTo update to a new CLI version:\n\n```bash\nbrew reinstall okta\n```\n\n\u003e**NOTE**\n\u003e \n\u003eIf you have issues installing the latest version, try removing the CLI using `brew untap` and then running `brew install` again:\n\u003e\n\u003e\n\u003e ```bash\n\u003e brew uninstall okta\n\u003e brew untap oktadeveloper/tap\n\u003e brew install --cask oktadeveloper/tap/okta\n\u003e ```\n\n### Linux Using Flatpak\nFirst add the Flathub repo if it's not already installed by running:\n\n```bash\nflatpak remote-add --if-not-exists flathub https://flathub.org/repo/flathub.flatpakrepo\n```\n\nNext, install the package:\n\n```bash\nflatpak install flathub com.okta.developer.CLI\n```\n\nFinally, add an alias to the command to the appropriate shell configuration (\"dot\") file:\n\n```bash\nalias okta=\"flatpak run com.okta.developer.CLI\"\n```\n\n### Linux or macOS using curl\n\nRun the following command in a terminal to install the CLI:\n\n```bash\ncurl https://raw.githubusercontent.com/okta/okta-cli/master/cli/src/main/scripts/install.sh | bash\n```\n\n### Windows Using Chocolatey\n\nRun the following command in a terminal to install the CLI:\n\n```bash\nchoco install okta --version=0.10.0\n```\n\n### Manual Install\n\nOpen the [releases download page for the Okta CLI](https://github.com/okta/okta-cli/releases) and download the executable file for your OS. Move that file to the desired location in your system. If appropriate, add the directory to your shell `PATH` environment variable, or add an alias in to the executable in the appropriate shell configuration (\"dot\") file.\n\n\n## Using the CLI\n\nFor general help run:\n\n`okta --help`\n\nFor help on a specific command, run:\n`okta help \u003ccommand\u003e`\n\n\n### Sign Up For a Free Okta Developer Account\n\nRun `okta register` to sign up for a new account. During the process you'll receive a verification code in a confirmation email sent from `noreply@okta.com`. If you don’t receive the email, check your spam folders.\n\nMake a note of the Okta Domain that's shown after your account is created as you'll use this for logging in and when you create apps.\n\n\u003e**IMPORTANT**\u003cbr/\u003e Set the password for your Okta developer organization by opening the link that’s shown after your domain is registered. Look for output similar to this:\n\u003e\n```\nYour Okta Domain: https://dev-xxxxxxx.okta.com\nTo set your password open this link:\nhttps://dev-xxxxxxx.okta.com/welcome/xrqyNKPCZcvxL1ouKUoh\n```\n\n\n### Log Into an Existing Account\n\nRun `okta login` to login to your developer Okta organization. You'll need the domain of the Okta organization domain and an access token.\n\n\u003e **NOTE**\u003cbr/\u003e You are automatically logged in when you use `okta register` to create an account.\n\nTo generate an access token:\n\n1. Log in to the admin console of your Okta organization.\n1. Open Security \u003e API.\n1. Select the Tokens tab and then select Okta API.\n1. Click Create Token and then enter a name for the new token.\n\n\n### Create an OAuth 2.0 / OIDC Okta Application\n\nRun the `okta apps create` command to create the Okta Application Integration for your single app. The CLI supports creating:\n\n- **Web apps**: Backend applications using Java, .Net, PHP, etc.\n- **Single page app (SPA)**: Browser based applications.\n- **Native app**: Mobile and desktop application.\n- **API service**: Machine to machine services.\n\nYou're prompted for the type of app and other required information. Note down the information shown after creating the integration as you'll need that for your app.\n\n\n## Add Bash / Zsh Completion\n\nThe third party software \"bash-completion\" enables adding command completion for the Okta CLI. To add completion run the command for your platform. For more information on bash-completion, see [the providers documentation](https://picocli.info/autocomplete.html#_installing_completion_scripts_permanently_in_bashzsh).\n\n### macOS\n\n```sh\nokta generate-completion \u003e /usr/local/etc/bash_completion.d/okta\n```\n\n### Linux\n\n```sh\nokta generate-completion \u003e /etc/bash_completion.d/okta\n```\n\n### Other\n\nIf you aren't using \"bash-completion\", copy the output of `okta generate-completion` to your desired location, and source the file from your `~/.bash_profile` script, for example:\n\n```sh\nokta generate-completion \u003e ~/okta.bash\necho `. ~/okta.bash` \u003e\u003e ~/.bash_profile\n```\n\n## Contribute\n\nOkta Command Line Interface is an [open project on GitHub](https://github.com/okta/okta-cli/blob/master). We invite you to download the source and propose changes.\n\n### Build the Okta CLI\n\nBuild your local version of the Okta CLI using [SDKMAN!](https://sdkman.io/).\n\nSet `sdkman_auto_env=true` in `~/.sdkman/etc/config` to select the correct JVM when you switch to the Okta CLI project folder.\n\nAlternately, when you are in the project folder select the correct JDK by runing `sdk env`.\n\nRun `mvn clean install` to build the CLI.\n\n\u003e**NOTE**\u003cbr/\u003e To avoid IntelliJ compiler errors for data class `getter` and `setter`, add the Lombok plugin.\n\n\n### Install and Run the CLI\n\nInstall your CLI build by running `gu install native-image`.\n\nRun your build using `./cli/target/okta`.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fokta%2Fokta-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fokta%2Fokta-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fokta%2Fokta-cli/lists"}