jgo Logo

User Guide

  • Getting Started
    • Installation
      • Prerequisites
      • As a library dependency
    • Quick Start
      • Run a Java program
      • Inspect dependencies
      • Create a project environment
      • Use from Python
    • Endpoint format
      • Coordinate modifiers
    • Next steps
  • CLI Reference
    • Usage
    • Global Options
      • Output control
      • Environment and cache
      • Resolver and dependencies
      • Java
      • Advanced
    • Commands
      • jgo run
      • jgo init
      • jgo add
      • jgo remove
      • jgo sync
      • jgo update
      • jgo lock
      • jgo list
      • jgo tree
      • jgo info
      • jgo search
      • jgo config
      • jgo version
    • Endpoint format
      • Coordinate modifiers
      • Explicit positioning
    • Examples
      • Basic usage
      • With the SciJava repository
      • Inspecting artifacts
      • Working with Java versions
  • Project Mode with jgo.toml
    • Creating a project
      • From an endpoint
      • From scratch
      • From a requirements file
    • jgo.toml specification
      • Sections
    • Managing dependencies
      • Adding dependencies
      • Removing dependencies
      • Updating dependencies
    • Running
    • Lock files
      • Lock file commands
    • Environment directory
      • Syncing
    • Version control
  • Python API
    • High-level API
      • jgo.run()
      • jgo.build()
      • jgo.resolve()
    • Layered API
      • Layer 1: Maven resolution (jgo.maven)
      • Layer 2: Environment materialization (jgo.env)
      • Layer 3: Execution (jgo.exec)
      • Combining layers
    • Backward compatibility
  • Configuration
    • Settings file
      • Format
      • [settings] section
      • [repositories] section
      • [shortcuts] section
    • Environment variables
    • Precedence

Topics

  • Dependency Management
    • How jgo handles dependency versions
      • Disabling managed mode per coordinate
    • Version resolution
      • How RELEASE and LATEST work
      • Checking resolved versions
    • Resolver options
      • Known Maven resolver bug: runtime scope promoted to compile
    • Link strategies
  • Recipes
    • Running language REPLs
    • Custom JVM options
    • Building a classpath for your IDE
    • Combining multiple artifacts
    • Working with SNAPSHOT versions
    • CI/CD usage
    • Reproducible project environments
    • Searching for artifacts
    • Using jgo as a library
      • Running ImageJ macro in a subprocess from Python
      • Getting a classpath for subprocess calls
      • Dependency analysis

Reference

  • Migrating from jgo 1.x
    • Backward compatibility
    • Python API changes
      • Old API (deprecated)
      • New API
      • Migration table
      • Advanced: layered API
    • CLI changes
      • Commands replace flags
      • Permanent short flags
      • Deprecated flags
      • Update behavior change
    • Configuration changes
      • Cache directory
      • Settings file
    • Breaking changes
    • New features in 2.x
      • jgo.toml project files
      • Automatic Java management
      • Pure Python resolver
      • Three-layer architecture
    • Testing your migration
  • Architecture
    • Layer 1: Maven (jgo.maven)
      • Concepts
      • Resolvers
      • Standalone use
    • Layer 2: Environment (jgo.env)
      • Environment structure
      • Link strategies
      • Cache modes
      • Bytecode detection
      • Standalone use
    • Layer 3: Execution (jgo.exec)
      • Java source strategies
      • Standalone use
    • Module structure
    • Design principles
  • Changelog
    • 3.0.0
      • Breaking changes
      • New features
    • 2.2.0
      • New features
    • 2.1.3
      • Bug fixes
    • 2.1.2
      • Improvements
    • 2.1.1
      • Bug fixes
      • Other changes
    • 2.1.0
      • New features
      • Bug fixes
    • 2.0.1
      • Bug fixes
    • 2.0.0
      • New features
      • Breaking changes
      • Deprecated

Development

  • Future Ideas
    • Contributing ideas
  • GitHub
  • Issue Tracker
jgo
  • Search

© Copyright disclaimed – see UNLICENSE.

Built with Sphinx using a theme provided by Read the Docs.