Skip to content

Latest commit

 

History

History
165 lines (111 loc) · 6.23 KB

Usage.md

File metadata and controls

165 lines (111 loc) · 6.23 KB
Raw

Using the Gradle-based Amper version from the command line

To use the Gradle-based version of Amper:

To learn how to add Amper to your existing Gradle project, check the documentation and the tutorial. After adding Amper, you can use Gradle as usual.

For example, to build and run the JVM "Hello, World" example:

cd jvm
./gradlew run

See the Gradle tutorial for more info.

To use Amper with Kotlin Multiplatform (e.g. running on devices and simulators), Fleet is recommended.

Updating Gradle-based Amper to a newer version

To find the latest Amper version, check the releases section in GitHub.

Then, update the Amper plugin version in your settings.gradle.kts file:

// ...
pluginManagement {
    repositories {
        // check Amper repositories:
        google()
        maven("https://packages.jetbrains.team/maven/p/amper/amper")
        maven("https://www.jetbrains.com/intellij-repository/releases")
        maven("https://packages.jetbrains.team/maven/p/ij/intellij-dependencies")
    }
}
// ...
plugins {
    // update the Amper plugin version here:
    id("org.jetbrains.amper.settings.plugin").version("0.4.0")
}
// ...

Using the standalone Amper version from the command line

The standalone version of Amper is a self-containing executable that can be downloaded using the standard OS tools.

To use the Amper CLI, you need to download the Amper executable script to your project's root folder. The script is a small file that downloads and runs the actual Amper CLI distribution.

Depending on your operating system, use one of the following commands to download the script: Linux/macOS:

curl -fsSL -o amper "https://packages.jetbrains.team/maven/p/amper/amper/org/jetbrains/amper/cli/0.4.0/cli-0.4.0-wrapper?download=true" && chmod +x amper

Windows powershell:

Invoke-WebRequest -Uri https://packages.jetbrains.team/maven/p/amper/amper/org/jetbrains/amper/cli/0.4.0/cli-0.4.0-wrapper.bat?download=true -OutFile amper.bat

Alternatively, you can use any other method to download the script from the Maven repository, as long as you save it with the correct name and extension.

After that, run the Amper script to explore what is possible using Amper CLI:

./amper --help

The first time you run the Amper script, it will take some time to download the JDK and Amper CLI distribution. Subsequent runs will be faster, as the downloaded files will be cached locally.

Useful commands:

  • amper init to create a new Amper project
  • amper build to compile and link all code in the project
  • amper test to run tests in the project
  • amper run to run your application
  • amper clean to remove the project's build output and caches

E.g. to build and run the JVM "Hello, World":

cd jvm
./amper run

Updating standalone Amper to a newer version

Use the same procedure as for downloading Amper executables.

Using Amper in IntelliJ IDEA

The latest IntelliJ IDEA EAP can be used to work with JVM and Android projects.

See the setup instructions to configure your IDE and the environment.

Open an Amper project as usual by pointing at the root folder.

To run an application:

  • use a 'run' () gutter icon next to the product: section in a module.yaml file:
    img.png

  • use a 'run' () gutter icon next to the main() function:

  • use Run/Debug configurations:

  • (Gradle-based projects only) launch a Gradle task directly:

To run tests use the same 'run' () gutter icon or Gradle run configuration. Read more on testing in IntelliJ IDEA.

Using Amper in Fleet

The latest version of JetBrains Fleet can be used to work with JVM, Android and Multiplatform projects.

Open an Amper project as usual by pointing at the root folder.

To run an application:

  • use a 'run' () gutter icon next to the product: section in a module.yaml file:

  • use a 'run' () gutter icon next to the main() function:

  • use Run configurations:

  • (Gradle-based projects only) launch a Gradle task directly:

To run tests, use the same 'run' () gutter icon or Gradle run configuration.

Configuring device and simulators

To select a target device used to run an Android or iOS application:

  • use the device switcher in the Fleet run configuration:

  • use the device switcher in the 'run' () gutter icon: