feat: Add IDE setup functionality to jfrog-cli-artifactory by agrasth · Pull Request #99 · jfrog/jfrog-cli-artifactory

agrasth · 2025-07-08T19:33:23Z

All tests passed. If this feature is not already covered by the tests, I added new tests.
All static analysis checks passed.
This pull request is on the dev branch.
I used gofmt for formatting the code before submitting the pull request.

Add IDE Setup Commands for VSCode and JetBrains IDEs

Summary

This PR introduces new CLI commands for configuring Visual Studio Code and JetBrains IDEs to use JFrog Artifactory as their extension/plugin repository. These commands enable organizations to control and curate the extensions/plugins available to their development teams.

Features Added

1. VSCode Configuration Command (`jf rt vscode-config`)

Configures VSCode to use Artifactory for extensions instead of the default Visual Studio Marketplace
Automatically detects VSCode installation across Windows, macOS, and Linux
Modifies the product.json file to redirect extension gallery requests
Creates automatic backups before making changes
Supports both alias (jf rt vscode) and full command name

2. JetBrains Configuration Command (`jf rt jetbrains-config`)

Configures JetBrains IDEs to use Artifactory for plugins instead of the default JetBrains Plugin Repository
Automatically detects all installed JetBrains IDEs (IntelliJ IDEA, PyCharm, WebStorm, PhpStorm, RubyMine, CLion, DataGrip, GoLand, Rider, Android Studio, AppCode, RustRover, Aqua)
Modifies each IDE's idea.properties file to add custom plugin repository URL
Creates automatic backups before making changes
Supports both alias (jf rt jetbrains) and full command name

3. Optional Repository Validation

Both commands support optional server authentication for repository validation
When server details are provided, validates that the target repository exists and has the correct package type
Works without server authentication for basic local configuration scenarios
Supports all JFrog CLI authentication methods (username/password, access token, server-id)

Technical Implementation

Architecture Overview

The implementation follows the established JFrog CLI plugin architecture pattern:

jfrog-cli-artifactory/
├── artifactory/cli/ide/          # CLI interface layer
│   ├── vscode/cli.go             # VSCode command definitions and argument parsing
│   └── jetbrains/cli.go          # JetBrains command definitions and argument parsing
└── artifactory/commands/ide/     # Business logic layer
    ├── vscode/vscode.go          # VSCode configuration logic
    └── jetbrains/jetbrains.go    # JetBrains configuration logic

Key Components

CLI Layer (artifactory/cli/ide/)

// Command registration and flag definitions
func GetCommands() []components.Command {
    return []components.Command{
        {
            Name:    "vscode-config",
            Aliases: []string{"vscode"},
            Action:  vscodeConfigCmd,
            // ... flags and description
        },
    }
}

Command Layer (artifactory/commands/ide/)

// Core business logic
type VscodeCommand struct {
    serviceURL     string
    productPath    string
    serverDetails  *config.ServerDetails
    repoKey        string
}

func (vc *VscodeCommand) Run() error {
    // Implementation: detect → validate → backup → configure
}

File Operations

VSCode Configuration

Locates product.json file across different installation paths
Modifies the extensionsGallery.serviceUrl property
Creates .backup file before modification
Validates JSON structure integrity

JetBrains Configuration

Locates idea.properties files for all detected IDE installations
Adds idea.plugins.host.list property pointing to Artifactory
Creates .backup files before modification
Handles both existing and new property addition

Operating System Support

Cross-Platform Path Detection

// Windows paths
[]string{
    filepath.Join(os.Getenv("USERPROFILE"), "AppData", "Local", "Programs", "Microsoft VS Code", "resources", "app", "product.json"),
    filepath.Join(os.Getenv("PROGRAMFILES"), "Microsoft VS Code", "resources", "app", "product.json"),
}

// macOS paths  
[]string{
    "/Applications/Visual Studio Code.app/Contents/Resources/app/product.json",
    filepath.Join(homeDir, "Applications", "Visual Studio Code.app", "Contents", "Resources", "app", "product.json"),
}

// Linux paths
[]string{
    "/usr/share/code/resources/app/product.json",
    "/opt/visual-studio-code/resources/app/product.json", 
    filepath.Join(homeDir, ".local", "share", "applications", "code", "resources", "app", "product.json"),
}

Repository Validation Integration

Conditional Validation

Repository validation only occurs when server authentication flags are provided
Uses existing JFrog CLI core validation utilities
Validates repository existence and package type compatibility
Gracefully handles authentication failures

Validation Flow

func (vc *VscodeCommand) validateRepository() error {
    if vc.serverDetails == nil {
        return nil // Skip validation if no server details provided
    }
    
    artDetails, err := vc.serverDetails.CreateArtAuthConfig()
    if err != nil {
        return fmt.Errorf("failed to create auth config: %w", err)
    }
    
    return utils.ValidateRepoExists(vc.repoKey, artDetails)
}

Files Added/Modified

New Files Added

artifactory/cli/ide/vscode/cli.go              # VSCode CLI interface (98 lines)
artifactory/cli/ide/jetbrains/cli.go           # JetBrains CLI interface (88 lines)  
artifactory/commands/ide/vscode/vscode.go      # VSCode command implementation (383 lines)
artifactory/commands/ide/jetbrains/jetbrains.go # JetBrains command implementation (383 lines)
IDE_SETUP_COMMANDS.md                          # Comprehensive documentation

Files Modified

artifactory/cli/cli.go                         # Added IDE command registration
├── Import statements (lines 8-9)             # Added IDE package imports
└── GetCommands() function (lines 409-413)    # Added command registration

Total Code Addition

952 lines of new Go code
Comprehensive test coverage for cross-platform functionality
Detailed documentation with usage examples and troubleshooting

Command Integration

Registration in CLI Framework

Commands are automatically registered in the JFrog CLI through the existing plugin architecture:

// In artifactory/cli/cli.go
func GetCommands() []components.Command {
    // ... existing commands
    
    // Add all VSCode commands
    commands = append(commands, vscode.GetCommands()...)
    // Add all JetBrains commands  
    commands = append(commands, jetbrains.GetCommands()...)
    
    return commands
}

This integration means the commands appear automatically in jf rt --help and function as first-class JFrog CLI commands.

Security Considerations

File System Security

Backup creation: Automatic backups prevent data loss from configuration errors
Permission checking: Commands verify file permissions before attempting modifications
Input validation: URLs and paths are validated before use
Atomic operations: File modifications are performed atomically to prevent partial updates

Documentation

Comprehensive User Guide

Added IDE_SETUP_COMMANDS.md providing:

Command syntax and examples for both VSCode and JetBrains commands
Cross-platform installation paths and expected file locations
Troubleshooting guide for common issues and error scenarios
Security best practices for enterprise deployment
Repository setup requirements for Artifactory administrators
CI/CD integration examples for automated developer onboarding

Help Text Integration

Inline help: Each command includes comprehensive help text accessible via --help
Example usage: Commands include multiple real-world usage examples
Flag documentation: All optional flags are documented with clear descriptions

Related PRs

jfrog/jfrog-cli#3027

- Add VSCode configuration command in artifactory/commands/ide/vscode/ - Add JetBrains configuration command in artifactory/commands/ide/jetbrains/ - Add CLI interfaces for both VSCode and JetBrains IDEs - Register IDE commands in main CLI registry - Implement proper repository validation using utils.ValidateRepoExists - Support complete URL inputs instead of separate repo/server flags - VSCode: Configure extensions service URL - JetBrains: Configure plugin repository URL This moves IDE setup functionality to the correct architectural location following jfrog-cli patterns where Artifactory-specific commands belong in jfrog-cli-artifactory module.

- VS Code and JetBrains commands now work without server authentication - Server details are only required if validation flags are provided - Improves user experience for local IDE configuration - Maintains backward compatibility with existing workflows

- Complete user guide with syntax, examples, and troubleshooting - Cross-platform installation paths and file locations - Repository validation and security considerations - CI/CD integration examples and best practices - Backup and recovery procedures - Enterprise deployment guidelines

bhanurp · 2025-07-14T07:27:19Z

artifactory/cli/cli.go


 func GetCommands() []components.Command {
-	return []components.Command{
+	commands := []components.Command{


instead of having commands here in artifactory/cli/cli.go it is looking good to move them as separate commands for jfrog-cli similar to lifecycle commands.

something similar to jf vscode config jf jetbrains config so that the command vscode can have its own sub commands like jf vscode install etc

bhanurp · 2025-07-15T04:21:12Z

IDE_SETUP_COMMANDS.md

@@ -0,0 +1,300 @@
+# JFrog CLI IDE Setup Commands


is this required? may be this can to documentation.

yes this removed.

bhanurp · 2025-07-15T04:30:32Z

artifactory/cli/ide/jetbrains/cli.go

+
+func jetbrainsConfigCmd(c *components.Context) error {
+	if c.GetNumberOfArgs() == 0 {
+		return fmt.Errorf("repository URL is required\n\nUsage: jf rt jetbrains-config <repository-url>\nExample: jf rt jetbrains-config https://mycompany.jfrog.io/artifactory/api/jetbrainsplugins/jetbrains-plugins")


there is function to send error message for wrong number of arguments, you can use it.

Thanks, updated it!

bhanurp · 2025-07-15T04:31:47Z

artifactory/cli/ide/jetbrains/cli.go

+		return fmt.Errorf("repository URL is required\n\nUsage: jf rt jetbrains-config <repository-url>\nExample: jf rt jetbrains-config https://mycompany.jfrog.io/artifactory/api/jetbrainsplugins/jetbrains-plugins")
+	}
+
+	repositoryURL := c.GetArgumentAt(0)


we have check above with number of arguments as 0 can still the argument can be empty string.

Thanks, updated it!

bhanurp · 2025-07-15T04:36:25Z

artifactory/cli/ide/jetbrains/cli.go

+
+// extractRepoKeyFromRepositoryURL extracts the repository key from a JetBrains repository URL
+// Expected format: https://<server>/artifactory/api/jetbrainsplugins/<repo-key>
+func extractRepoKeyFromRepositoryURL(repositoryURL string) string {


isn't there any existing function in jfrog-cli-core which can give us repository name instead of rewriting?

bhanurp · 2025-07-15T05:55:28Z

artifactory/commands/ide/vscode/vscode.go

+// getManualSetupInstructions returns manual setup instructions
+func (vc *VscodeCommand) getManualSetupInstructions(serviceURL string) string {
+	instructions := fmt.Sprintf(`
+Manual VSCode Setup Instructions:


can we group the instructions or similar statements into a single file and use those constants to make it more readable.

bhanurp · 2025-07-15T05:59:09Z

artifactory/commands/ide/jetbrains/jetbrains.go

+	for _, ide := range jc.detectedIDEs {
+		log.Info("  " + ide.Name + " " + ide.Version)
+	}


redundant and can be removed.

bhanurp · 2025-07-15T06:02:36Z

artifactory/commands/ide/jetbrains/jetbrains.go

+	// Sort IDEs by name for consistent output
+	sort.Slice(jc.detectedIDEs, func(i, j int) bool {
+		return jc.detectedIDEs[i].Name < jc.detectedIDEs[j].Name
+	})


what is consistent output?

The consistent output refers to ensuring that detected IDEs are always displayed in the same alphabetical order by name, regardless of the order they were discovered during the detection process.

bhanurp · 2025-07-15T06:03:22Z

artifactory/commands/ide/jetbrains/jetbrains.go

+		}
+		lines = append(lines, "# JFrog Artifactory plugins repository")
+		lines = append(lines, fmt.Sprintf("idea.plugins.host=%s", repositoryURL))
+		log.Info("  Added idea.plugins.host property")


Suggested change

log.Info(" Added idea.plugins.host property")

log.Info("Added idea.plugins.host property")

bhanurp · 2025-07-15T06:04:28Z

artifactory/commands/ide/jetbrains/jetbrains.go

+		configPath = "[JetBrains config directory]/[IDE][VERSION]/idea.properties"
+	}
+
+	instructions := fmt.Sprintf(`


you can regroup these common instructions.

…ure modular command registration

bhanurp · 2025-07-17T14:13:47Z

artifactory/cli/ide/vscode/cli.go

+	return rtDetails, nil
+}
+
+func isValidUrl(s string) bool {


duplicated function same available in jetbrains as well

Yeah, thankyou. moved.

bhanurp · 2025-07-17T14:15:07Z

artifactory/commands/ide/jetbrains/jetbrains.go

+
+// validateRepository uses the established pattern for repository validation
+func (jc *JetbrainsCommand) validateRepository() error {
+	log.Info("Validating repository...")


Suggested change

log.Info("Validating repository...")

log.Debug("Validating repository...")

Done, thanks

bhanurp · 2025-07-17T14:21:55Z

artifactory/commands/ide/vscode/vscode.go

+
+	log.Info("VSCode configuration updated successfully. Repository URL:", vc.serviceURL, "- Please restart VSCode to apply changes")
+
+	return nil


Suggested change

log.Info("VSCode configuration updated successfully. Repository URL:", vc.serviceURL, "- Please restart VSCode to apply changes")

return nil

log.Info("VSCode configuration updated successfully. Repository URL:", vc.serviceURL, "- Please restart VSCode to apply changes")

return nil

bhanurp · 2025-07-17T14:24:03Z

cliutils/flagkit/flags.go

 	lcIncludeRepos: components.NewStringFlag(IncludeRepos, "List of semicolon-separated(;) repositories to include in the promotion. If this property is left undefined, all repositories (except those specifically excluded) are included in the promotion. "+
 		"If one or more repositories are specifically included, all other repositories are excluded.` `", components.SetMandatoryFalse()),
-	lcExcludeRepos:           components.NewStringFlag(ExcludeRepos, "List of semicolon-separated(;) repositories to exclude from the promotion.` `", components.SetMandatoryFalse()),
+	lcExcludeRepos:           components.NewStringFlag(ExcludeRepos, "List of semicolon-seperated(;) repositories to exclude from the promotion.` `", components.SetMandatoryFalse()),


why is the change?

This spelling was inconsistent, among this file. So corrected it.

wait I will remove this change, might affect any script

agrasth force-pushed the feature/ide-setup-clean-v2 branch 2 times, most recently from ad38385 to 62036f6 Compare July 9, 2025 21:07

agrasth had a problem deploying to frogbot July 9, 2025 21:07 — with GitHub Actions Failure

agrasth added 4 commits July 10, 2025 02:43

Updated decp and added tests

2d73676

agrasth force-pushed the feature/ide-setup-clean-v2 branch from b5bb627 to 2d73676 Compare July 9, 2025 21:13

agrasth had a problem deploying to frogbot July 9, 2025 21:13 — with GitHub Actions Failure

agrasth had a problem deploying to frogbot July 9, 2025 21:23 — with GitHub Actions Failure

agrasth added safe to test Approve running integration tests on a pull request improvement Automatically generated release notes labels Jul 9, 2025

agrasth self-assigned this Jul 9, 2025

agrasth requested review from bhanurp and itsmeleela July 9, 2025 21:31

Fix test failures and improve implementation

7fc0a96

agrasth force-pushed the feature/ide-setup-clean-v2 branch from 69326cb to 7fc0a96 Compare July 9, 2025 23:04

agrasth had a problem deploying to frogbot July 9, 2025 23:04 — with GitHub Actions Failure

bhanurp requested changes Jul 15, 2025

View reviewed changes

agrasth had a problem deploying to frogbot July 15, 2025 07:17 — with GitHub Actions Failure

agrasth had a problem deploying to frogbot July 15, 2025 07:18 — with GitHub Actions Failure

This was referenced Jul 15, 2025

feat: IDE setup for vscode and jetbrains jfrog/jfrog-cli#3027

Merged

Feature/ide setup clean jfrog/jfrog-cli-core#1413

Closed

Updated code on reviews and feedback

1644e2e

agrasth force-pushed the feature/ide-setup-clean-v2 branch from 9c355ba to 1644e2e Compare July 15, 2025 09:10

agrasth had a problem deploying to frogbot July 15, 2025 09:10 — with GitHub Actions Failure

agrasth had a problem deploying to frogbot July 17, 2025 08:45 — with GitHub Actions Failure

agrasth had a problem deploying to frogbot July 17, 2025 08:46 — with GitHub Actions Failure

agrasth force-pushed the feature/ide-setup-clean-v2 branch from 7e443d2 to a0ed5e9 Compare July 17, 2025 09:03

Fix IDE CLI commands: clean help output, hide legacy aliases, and ens…

4d44b8a

…ure modular command registration

agrasth had a problem deploying to frogbot July 17, 2025 11:46 — with GitHub Actions Failure

agrasth had a problem deploying to frogbot July 17, 2025 12:17 — with GitHub Actions Failure

Fix IDE CLI commands: clean help output, hide legacy aliases, and ens…

3db2326

…ure modular command registration

agrasth force-pushed the feature/ide-setup-clean-v2 branch from bc69d6f to 3db2326 Compare July 17, 2025 12:23

agrasth had a problem deploying to frogbot July 17, 2025 12:23 — with GitHub Actions Failure

bhanurp added new feature Automatically generated release notes and removed safe to test Approve running integration tests on a pull request improvement Automatically generated release notes labels Jul 17, 2025

agrasth had a problem deploying to frogbot July 17, 2025 12:59 — with GitHub Actions Failure

agrasth force-pushed the feature/ide-setup-clean-v2 branch from 9e5eee2 to e4cf3fc Compare July 17, 2025 13:07

agrasth had a problem deploying to frogbot July 17, 2025 13:07 — with GitHub Actions Failure

Fix validations fixes

c7ddf3c

agrasth force-pushed the feature/ide-setup-clean-v2 branch from e4cf3fc to c7ddf3c Compare July 17, 2025 13:26

agrasth had a problem deploying to frogbot July 17, 2025 13:26 — with GitHub Actions Failure

bhanurp requested changes Jul 17, 2025

View reviewed changes

Fixed comment

93ac10a

agrasth had a problem deploying to frogbot July 17, 2025 19:26 — with GitHub Actions Failure

Fix test failure

1a264de

agrasth had a problem deploying to frogbot July 17, 2025 19:45 — with GitHub Actions Failure

agrasth had a problem deploying to frogbot July 17, 2025 20:11 — with GitHub Actions Failure

agrasth force-pushed the feature/ide-setup-clean-v2 branch from 3885547 to 22ac331 Compare July 17, 2025 20:15

agrasth had a problem deploying to frogbot July 17, 2025 20:15 — with GitHub Actions Failure

Fix jetbrains tests for windows

be890a5

agrasth force-pushed the feature/ide-setup-clean-v2 branch from 22ac331 to be890a5 Compare July 17, 2025 23:11

agrasth had a problem deploying to frogbot July 17, 2025 23:11 — with GitHub Actions Failure

Merge branch 'main' into feature/ide-setup-clean-v2

e1aab23

agrasth had a problem deploying to frogbot July 18, 2025 06:47 — with GitHub Actions Failure

agrasth merged commit 4a60768 into jfrog:main Jul 18, 2025
10 of 11 checks passed

naveenku-jfrog pushed a commit to naveenku-jfrog/jfrog-cli-artifactory that referenced this pull request Aug 13, 2025

feat: Add IDE setup functionality to jfrog-cli-artifactory (jfrog#99)

fe395ae

	log.Info(" Added idea.plugins.host property")
	log.Info("Added idea.plugins.host property")

	log.Info("Validating repository...")
	log.Debug("Validating repository...")


		log.Info("VSCode configuration updated successfully. Repository URL:", vc.serviceURL, "- Please restart VSCode to apply changes")

		return nil

Conversation

agrasth commented Jul 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Add IDE Setup Commands for VSCode and JetBrains IDEs

Summary

Features Added

1. VSCode Configuration Command (jf rt vscode-config)

2. JetBrains Configuration Command (jf rt jetbrains-config)

3. Optional Repository Validation

Technical Implementation

Architecture Overview

Key Components

File Operations

Operating System Support

Repository Validation Integration

Files Added/Modified

New Files Added

Files Modified

Total Code Addition

Command Integration

Registration in CLI Framework

Security Considerations

File System Security

Documentation

Comprehensive User Guide

Help Text Integration

Related PRs

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

agrasth Jul 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

agrasth commented Jul 8, 2025 •

edited

Loading

1. VSCode Configuration Command (`jf rt vscode-config`)

2. JetBrains Configuration Command (`jf rt jetbrains-config`)

agrasth Jul 15, 2025 •

edited

Loading