General Commands
General commands handle authentication, tokens, statistics, and CLI configuration. You use these commands to log in, create tokens, and inspect environment options. This page links to each command and related procedures so you can jump straight to the task you need.
Tasks in this section
- Log in to the JFrog Platform in a browser
- Create an access token
- Exchange an OIDC token for a JFrog access token
- Connect AI agents to the JFrog MCP server
- Generate a Markdown summary of recorded CLI commands
- Retrieve product statistics
- List supported environment variables
- Use API endpoints via the CLI
- Use cURL against Artifactory with stored credentials (planned for deprecation; use
jf apiinstead) - Store symlinks in Artifactory
Overview
The following table lists general commands, aliases, and short descriptions.
| Command | Alias | Description |
|---|---|---|
| jf api | jf api | Invoke any JFrog Platform HTTP API using the configured server URL and credentials |
| jf login | — | Log in to the JFrog Platform through your web browser. Available for Artifactory 7.64.0 or later |
| jf access-token-create | atc | Create an access token. Requires authentication |
| jf exchange-oidc-token | eot | Exchange an OIDC token ID for a JFrog access token |
| jf mcp | — | Discover and configure the remote JFrog MCP server for AI agents. Subcommands: show, install, uninstall |
| jf generate-summary-markdown | gsm | Generate a summary of recorded CLI commands in Markdown. Requires JFROG_CLI_COMMAND_SUMMARY_OUTPUT_DIR |
| jf stats | st | Returns statistics for a product on a given server. Requires authentication |
| jf options | — | Show all supported environment variables |
| jf rt curl | rt cl | Planned for deprecation. Execute a cURL command against Artifactory using stored credentials. Use jf api instead, which covers all JFrog Platform APIs |
| Storing Symlinks in Artifactory | — | Upload and download symlinks with jf rt upload and jf rt download (Linux and macOS only) |
When to Use
- login: Use when you want browser-based authentication without storing credentials manually.
- access-token-create: Use to create tokens for continuous integration (CI), scripts, or service accounts.
- exchange-oidc-token: Use when authenticating with OIDC providers (GitHub, Azure, or a generic provider).
- mcp: Use to connect AI agents (Cursor or Claude Code) to the JFrog MCP server so the agent can call JFrog Platform APIs during AI-assisted workflows.
- generate-summary-markdown: Use to produce a Markdown report of CLI usage for documentation or auditing.
- stats: Use to inspect product statistics (Artifactory or
rt). - options: Use to discover all environment variables the CLI supports.
- jf api: Use to call any JFrog Platform REST API (Access, Artifactory, AppTrust, OneModel, and others) directly from the CLI without managing authentication headers manually. Recommended for new scripts.
- rt curl: Planned for deprecation. Existing usage continues to work, but new scripts should use
jf apiinstead. - Storing symlinks: Use to persist and restore symbolic links in Artifactory (Linux and macOS only).
Global CLI Flags
Global flags apply to every jf command and are passed before the subcommand name.
| Flag | Description | More information |
|---|---|---|
--ai-help | Forces AI-agent-oriented help text for --help output on any command. When active, descriptions expand to include when to use the command, prerequisites, examples, and gotchas. Automatically enabled when the CLI detects it is running inside a known AI agent. | AI-Oriented Help |
--ai-help has an environment variable counterpart — JFROG_CLI_AI_HELP — documented in the Environment Variables reference.
For structured JSON error output, use the JFROG_CLI_ERROR_OUTPUT_FORMAT=json environment variable (global) or pass --format=json on any individual command that supports it. See HTTP Error Output.
Updated 26 days ago
What’s Next
Start by logging in to your JFrog Platform instance.