Spring Boot CLI

Spring Boot CLI — это командная утилита, которую можно использовать для создания нового проекта с start.spring.io или для кодирования пароля.

1. Установка CLI

Spring Boot CLI (Командная строка) можно установить вручную, используя SDKMAN! (SDK Manager), или Homebrew или MacPorts, если вы пользователь OSX. См. getting-started.html в разделе «Начало работы» для получения подробных инструкций по установке.

2. Использование CLI

После установки CLI вы можете запустить его, набрав spring и нажав Enter в командной строке. Если вы запустите spring без каких-либо аргументов, отобразится экран справки, как показано ниже:

$ spring
usage: spring [--help] [--version]
       <command> [<args>]

Available commands are:

  init [options] [location]
    Initialize a new project using Spring Initializr (start.spring.io)

  encodepassword [options] <password to encode>
    Encode a password for use with Spring Security

  shell
    Start a nested shell

Common options:

  --debug Verbose mode
    Print additional status information for the command you are running


See 'spring help <command>' for more information on a specific command.

Вы можете набрать spring help для получения более подробной информации о поддерживаемых командах, как показано в следующем примере:

$ spring help init
spring init - Initialize a new project using Spring Initializr (start.spring.io)

usage: spring init [options] [location]

Option                       Description
------                       -----------
-a, --artifact-id <String>   Project coordinates; infer archive name (for
                               example 'test')
-b, --boot-version <String>  Spring Boot version (for example '1.2.0.RELEASE')
--build <String>             Build system to use (for example 'maven' or
                               'gradle') (default: maven)
-d, --dependencies <String>  Comma-separated list of dependency identifiers to
                               include in the generated project
--description <String>       Project description
-f, --force                  Force overwrite of existing files
--format <String>            Format of the generated content (for example
                               'build' for a build file, 'project' for a
                               project archive) (default: project)
-g, --group-id <String>      Project coordinates (for example 'org.test')
-j, --java-version <String>  Language level (for example '1.8')
-l, --language <String>      Programming language  (for example 'java')
--list                       List the capabilities of the service. Use it to
                               discover the dependencies and the types that are
                               available
-n, --name <String>          Project name; infer application name
-p, --packaging <String>     Project packaging (for example 'jar')
--package-name <String>      Package name
-t, --type <String>          Project type. Not normally needed if you use --
                               build and/or --format. Check the capabilities of
                               the service (--list) for more details
--target <String>            URL of the service to use (default: https://start.
                               spring.io)
-v, --version <String>       Project version (for example '0.0.1-SNAPSHOT')
-x, --extract                Extract the project archive. Inferred if a
                               location is specified without an extension

examples:

    To list all the capabilities of the service:
        $ spring init --list

    To creates a default project:
        $ spring init

    To create a web my-app.zip:
        $ spring init -d=web my-app.zip

    To create a web/data-jpa gradle project unpacked:
        $ spring init -d=web,jpa --build=gradle my-dir

Команда version предоставляет быстрый способ проверки версии Spring Boot, которую вы используете, как показано ниже:

$ spring version
Spring CLI v3.1.3

2.1. Инициализация нового проекта

Команда init позволяет создать новый проект, используя start.spring.io, не выходя из оболочки, как показано в следующем примере:

$ spring init --dependencies=web,data-jpa my-project
Using service at https://start.spring.io
Project extracted to '/Users/developer/example/my-project'

В предыдущем примере создаётся каталог my-project с проектом на основе Maven, который использует spring-boot-starter-web и spring-boot-starter-data-jpa. Вы можете перечислить возможности сервиса, используя флаг --list, как показано в следующем примере:

$ spring init --list
=======================================
Capabilities of https://start.spring.io
=======================================

Available dependencies:
-----------------------
actuator - Actuator: Production ready features to help you monitor and manage your application
...
web - Web: Support for full-stack web development, including Tomcat and spring-webmvc
websocket - Websocket: Support for WebSocket development
ws - WS: Support for Spring Web Services

Available project types:
------------------------
gradle-build -  Gradle Config [format:build, build:gradle]
gradle-project -  Gradle Project [format:project, build:gradle]
maven-build -  Maven POM [format:build, build:maven]
maven-project -  Maven Project [format:project, build:maven] (default)

...

Команда init поддерживает множество опций. См. вывод help для получения дополнительной информации. Например, следующая команда создаёт проект Gradle, который использует Java 17 и war упаковку:

$ spring init --build=gradle --java-version=17 --dependencies=websocket --packaging=war sample-app.zip
Using service at https://start.spring.io
Content saved to 'sample-app.zip'

2.2. Использование встроенной оболочки

Spring Boot включает скрипты завершения командной строки для оболочек BASH и zsh. Если вы не используете ни одну из этих оболочек (возможно, вы пользователь Windows), вы можете использовать команду shell для запуска интегрированной оболочки, как показано в следующем примере:

$ spring shell
Spring Boot (v3.1.3)
Hit TAB to complete. Type \'help' and hit RETURN for help, and \'exit' to quit.

Изнутри встроенной оболочки вы можете напрямую запускать другие команды:

$ version
Spring CLI v3.1.3

Встроенная оболочка поддерживает вывод ANSI-цветов, а также tab завершение. Если вам нужно запустить системную команду, вы можете использовать префикс !. Чтобы выйти из встроенной оболочки, нажмите ctrl-c.