org.pkl.cli.commands.DownloadPackageCommand.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of pkl-tools Show documentation

Fat Jar containing pkl-cli, pkl-codegen-java, pkl-codegen-kotlin, pkl-config-java, pkl-core, pkl-doc, and their shaded third-party dependencies.

There is a newer version: 0.27.1

Show newest version

/*
 * Copyright © 2024 Apple Inc. and the Pkl project authors. All rights reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.pkl.cli.commands

import org.pkl.thirdparty.clikt.parameters.arguments.argument
import org.pkl.thirdparty.clikt.parameters.arguments.convert
import org.pkl.thirdparty.clikt.parameters.arguments.multiple
import org.pkl.thirdparty.clikt.parameters.groups.provideDelegate
import org.pkl.thirdparty.clikt.parameters.options.flag
import org.pkl.thirdparty.clikt.parameters.options.option
import org.pkl.cli.CliPackageDownloader
import org.pkl.commons.cli.commands.BaseCommand
import org.pkl.commons.cli.commands.ProjectOptions
import org.pkl.commons.cli.commands.single
import org.pkl.core.packages.PackageUri

class DownloadPackageCommand(helpLink: String) :
  BaseCommand(
    name = "download-package",
    helpLink = helpLink,
    help =
      """
    Download package(s)
    
    This command downloads the specified packages to the cache directory.
    If the package already exists in the cache directory, this command is a no-op.
    
    Examples:
    ```
    # Download two packages
    $ pkl download-package package://example.com/[email protected] package://example.com/[email protected] 
    ```
  """
        .trimIndent()
  ) {
  private val projectOptions by ProjectOptions()

  private val packageUris: List by
    argument("", "The package URIs to download")
      .convert { PackageUri(it) }
      .multiple(required = true)

  private val noTransitive: Boolean by
    option(
        names = arrayOf("--no-transitive"),
        help = "Skip downloading transitive dependencies of a package"
      )
      .single()
      .flag()

  override fun run() {
    CliPackageDownloader(
        baseOptions.baseOptions(emptyList(), projectOptions),
        packageUris,
        noTransitive
      )
      .run()
  }
}