Skip to content
This repository was archived by the owner on May 14, 2025. It is now read-only.

Commit db64ef1

Browse files
jvalkealjvalkeal
committed
Overhaul initializr docs
- Remove unrelated content and shuffle some things around - Use asciinema for interactive sample - Relates #192
1 parent 65857db commit db64ef1

File tree

6 files changed

+114
-247
lines changed

6 files changed

+114
-247
lines changed

‎docs/antora-playbook.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ antora:
1010
- '@springio/antora-extensions/latest-version-extension'
1111
- require: '@springio/antora-extensions/root-component-extension'
1212
root_component_name: 'cli'
13+
- require: '@springio/antora-extensions/asciinema-extension'
1314
site:
1415
title: Spring CLI Reference
1516
content:

‎docs/modules/ROOT/examples/boot-start-interactive.cast

Lines changed: 95 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,95 @@
1+
{"version": 2, "width": 80, "height": 24, "timestamp": 1715162358, "env": {"SHELL": "/bin/bash", "TERM": "xterm-256color"}, "title": "boot start demo"}
2+
[0.21928, "o", "\u001b[?2004h\u001b]0;localhost: /tmp/projects\u0007\u001b[01;32mlocalhost\u001b[00m:\u001b[01;34m/tmp/projects\u001b[00m$ "]
3+
[1.598795, "o", "s"]
4+
[1.698534, "o", "p"]
5+
[1.873401, "o", "r"]
6+
[2.214584, "o", "i"]
7+
[2.504956, "o", "n"]
8+
[2.703727, "o", "g"]
9+
[3.1789, "o", " "]
10+
[3.332739, "o", "b"]
11+
[3.437327, "o", "o"]
12+
[3.581676, "o", "o"]
13+
[3.680583, "o", "t"]
14+
[3.778625, "o", " "]
15+
[3.915436, "o", "s"]
16+
[4.104531, "o", "t"]
17+
[4.227888, "o", "a"]
18+
[4.338745, "o", "r"]
19+
[4.560672, "o", "t"]
20+
[4.656695, "o", "\r\n"]
21+
[4.656758, "o", "\u001b[?2004l\r"]
22+
[9.701698, "o", "\u001b[?1h\u001b=\u001b[?25l"]
23+
[9.791624, "o", "\u001b[32;1m?\u001b[0m \u001b[1mPath\u001b[0m \r"]
24+
[10.270603, "o", "\u001b[7Cd\u001b[71C \u001b[32mℹ\u001b[0m \u001b[32mPath ok\u001b[0m\u001b[A\r"]
25+
[10.541501, "o", "\u001b[8Ce\r"]
26+
[10.725159, "o", "\u001b[9Cm\r"]
27+
[10.818521, "o", "\u001b[10Co\r"]
28+
[11.129848, "o", "\u001b[?1l\u001b>\u001b[?12l\u001b[?25h\u001b[K\r\r\n\u001b[K\u001b[A"]
29+
[11.139639, "o", "\u001b[32;1m?\u001b[0m \u001b[1mPath\u001b[0m \u001b[34mdemo\u001b[0m\r\n"]
30+
[11.152163, "o", "\u001b[?1h\u001b=\u001b[?25l"]
31+
[11.170306, "o", "\u001b[32;1m?\u001b[0m \u001b[1mProject\u001b[0m [Use arrows to move], type to filter\u001b[33C \u001b[96;1m❯\u001b[0m\u001b[96;1m Gradle - Groovy\u001b[0m\u001b[62C Gradle - Kotlin\u001b[62C Maven\u001b[3A\r"]
32+
[11.953958, "o", "\u001b[?1l\u001b>\u001b[?12l\u001b[?25h\u001b[K\r\r\n\u001b[K\r\r\n\u001b[K\r\r\n\u001b[K\u001b[3A"]
33+
[11.963925, "o", "\u001b[32;1m?\u001b[0m \u001b[1mProject\u001b[0m \u001b[34mgradle-project\u001b[0m\r\n"]
34+
[11.966646, "o", "\u001b[?1h\u001b=\u001b[?25l"]
35+
[11.978019, "o", "\u001b[32;1m?\u001b[0m \u001b[1mLanguage\u001b[0m [Use arrows to move], type to filter\u001b[32C Groovy\u001b[71C \u001b[96;1m❯\u001b[0m\u001b[96;1m Java\u001b[0m\u001b[73C Kotlin\u001b[3A\r"]
36+
[12.797495, "o", "\u001b[?1l\u001b>\u001b[?12l\u001b[?25h\u001b[K\r\r\n\u001b[K\r\r\n\u001b[K\r\r\n\u001b[K\u001b[3A"]
37+
[12.807706, "o", "\u001b[32;1m?\u001b[0m \u001b[1mLanguage\u001b[0m \u001b[34mjava\u001b[0m\r\n"]
38+
[12.810888, "o", "\u001b[?1h\u001b=\u001b[?25l"]
39+
[12.821473, "o", "\u001b[32;1m?\u001b[0m \u001b[1mSpring Boot\u001b[0m [Use arrows to move], type to filter\u001b[29C 3.3.0 (SNAPSHOT)\u001b[61C 3.3.0 (RC1)\u001b[66C 3.2.6 (SNAPSHOT)\u001b[61C \u001b[96;1m❯\u001b[0m\u001b[96;1m 3.2.5\u001b[0m\u001b[72C 3.1.12 (SNAPSHOT)\u001b[5A\r"]
40+
[13.533917, "o", "\u001b[?1l\u001b>\u001b[?12l\u001b[?25h\u001b[K\r\r\n\u001b[K\r\r\n\u001b[K\r\r\n\u001b[K\r\r\n\u001b[K\r\r\n\u001b[K\u001b[5A"]
41+
[13.542333, "o", "\u001b[32;1m?\u001b[0m \u001b[1mSpring Boot\u001b[0m \u001b[34m3.2.5\u001b[0m\r\n"]
42+
[13.547667, "o", "\u001b[?1h\u001b=\u001b[?25l"]
43+
[13.554514, "o", "\u001b[32;1m?\u001b[0m \u001b[1mVersion\u001b[0m \u001b[34m[Default 0.0.1-SNAPSHOT]\u001b[0m\r"]
44+
[14.301515, "o", "\u001b[?1l\u001b>\u001b[?12l\u001b[?25h\u001b[K"]
45+
[14.309766, "o", "\u001b[32;1m?\u001b[0m \u001b[1mVersion\u001b[0m \u001b[34m0.0.1-SNAPSHOT\u001b[0m\r\n"]
46+
[14.311799, "o", "\u001b[?1h\u001b=\u001b[?25l"]
47+
[14.317778, "o", "\u001b[32;1m?\u001b[0m \u001b[1mGroup\u001b[0m \u001b[34m[Default com.example]\u001b[0m\r"]
48+
[14.950298, "o", "\u001b[?1l\u001b>\u001b[?12l\u001b[?25h\u001b[K"]
49+
[14.957231, "o", "\u001b[32;1m?\u001b[0m \u001b[1mGroup\u001b[0m \u001b[34mcom.example\u001b[0m\r\n"]
50+
[14.959095, "o", "\u001b[?1h\u001b=\u001b[?25l"]
51+
[14.965188, "o", "\u001b[32;1m?\u001b[0m \u001b[1mArtifact\u001b[0m \u001b[34m[Default demo]\u001b[0m\r"]
52+
[15.577063, "o", "\u001b[?1l\u001b>\u001b[?12l\u001b[?25h\u001b[K"]
53+
[15.583043, "o", "\u001b[32;1m?\u001b[0m \u001b[1mArtifact\u001b[0m \u001b[34mdemo\u001b[0m\r\n"]
54+
[15.585106, "o", "\u001b[?1h\u001b=\u001b[?25l"]
55+
[15.590771, "o", "\u001b[32;1m?\u001b[0m \u001b[1mName\u001b[0m \u001b[34m[Default demo]\u001b[0m\r"]
56+
[16.203508, "o", "\u001b[?1l\u001b>\u001b[?12l\u001b[?25h\u001b[K"]
57+
[16.209216, "o", "\u001b[32;1m?\u001b[0m \u001b[1mName\u001b[0m \u001b[34mdemo\u001b[0m\r\n"]
58+
[16.211024, "o", "\u001b[?1h\u001b=\u001b[?25l"]
59+
[16.217025, "o", "\u001b[32;1m?\u001b[0m \u001b[1mDescription\u001b[0m \u001b[34m[Default Demo project for Spring Boot]\u001b[0m\r"]
60+
[16.866897, "o", "\u001b[?1l\u001b>\u001b[?12l\u001b[?25h\u001b[K"]
61+
[16.87268, "o", "\u001b[32;1m?\u001b[0m \u001b[1mDescription\u001b[0m \u001b[34mDemo project for Spring Boot\u001b[0m\r\n"]
62+
[16.874574, "o", "\u001b[?1h\u001b=\u001b[?25l"]
63+
[16.880017, "o", "\u001b[32;1m?\u001b[0m \u001b[1mPackage Name\u001b[0m \u001b[34m[Default com.example.demo]\u001b[0m\r"]
64+
[17.583066, "o", "\u001b[?1l\u001b>\u001b[?12l\u001b[?25h\u001b[K"]
65+
[17.589014, "o", "\u001b[32;1m?\u001b[0m \u001b[1mPackage Name\u001b[0m \u001b[34mcom.example.demo\u001b[0m\r\n"]
66+
[17.606425, "o", "\u001b[?1h\u001b=\u001b[?25l"]
67+
[17.622433, "o", "\u001b[32;1m?\u001b[0m \u001b[1mDependencies\u001b[0m [Use arrows to move], type to filter\u001b[28C \u001b[96;1m❯\u001b[0m\u001b[96;1m \u001b[39m☐ \u001b[0m Amazon Bedrock\u001b[60C \u001b[1m☐ \u001b[0m Apache Camel\u001b[62C \u001b[1m☐ \u001b[0m Apache Derby Database\u001b[53C \u001b[1m☐ \u001b[0m Apache Freemarker\u001b[57C \u001b[1m☐ \u001b[0m Apache Zookeeper Configuration\u001b[44C \u001b[1m☐ \u001b[0m Apache Zookeeper Discovery\u001b[48C \u001b[1m☐ \u001b[0m Azure AI Search\u001b[7A\r"]
68+
[18.739666, "o", "\u001b[37Cfiltering 'w'\u001b[K\r\r\n\u001b[5CFlyway Migration\u001b[K\r\r\n\u001b[5CGateway\u001b[K\r\r\n\u001b[5CMyBatis Framework\u001b[K\r\r\n\u001b[5CNew Relic\u001b[K\r\r\n\u001b[5CReactive Gateway\u001b[K\r\r\n\u001b[5CSpring Reactive Web\u001b[K\r\r\n\u001b[5CSpring Web\u001b[K\u001b[7A\r"]
69+
[18.978265, "o", "\u001b[49C\u001b[1@e\r\r\n\u001b[5CSpring Reactive Web\u001b[K\r\r\n\u001b[5CSpring Web\u001b[K\r\r\n\u001b[5CSpring Web Services\u001b[K\r\r\n\u001b[5CWeaviate Vector Database\u001b[K\r\r\n\u001b[5CWebSocket\u001b[K\r\r\n\u001b[K\r\r\n\u001b[K\u001b[7A"]
70+
[19.709085, "o", "\u001b[50C\u001b[1@b\r\r\n\r\n\r\n\r\n\u001b[7CbSocket\u001b[K\r\r\n\u001b[K\u001b[5A"]
71+
[21.273426, "o", "\r\r\n \r\r\n\u001b[96;1m❯ \u001b[0m\u001b[2A\r"]
72+
[21.91046, "o", "\r\r\n\r\n\u001b[2C\u001b[32m☒ \u001b[0m\u001b[2A\r"]
73+
[22.564402, "o", "\u001b[?1l\u001b>\u001b[?12l\u001b[?25h\u001b[K\r\r\n\u001b[K\r\r\n\u001b[K\r\r\n\u001b[K\r\r\n\u001b[K\u001b[4A"]
74+
[22.573108, "o", "\u001b[32;1m?\u001b[0m \u001b[1mDependencies\u001b[0m \u001b[34mweb\u001b[0m\r\n"]
75+
[22.575187, "o", "\u001b[?1h\u001b=\u001b[?25l"]
76+
[22.58195, "o", "\u001b[32;1m?\u001b[0m \u001b[1mPackaging\u001b[0m [Use arrows to move], type to filter\u001b[31C \u001b[96;1m❯\u001b[0m\u001b[96;1m Jar\u001b[0m\u001b[74C War\u001b[2A\r"]
77+
[23.727653, "o", "\u001b[?1l\u001b>\u001b[?12l\u001b[?25h\u001b[K\r\r\n\u001b[K\r\r\n\u001b[K\u001b[2A"]
78+
[23.733373, "o", "\u001b[32;1m?\u001b[0m \u001b[1mPackaging\u001b[0m \u001b[34mjar\u001b[0m\r\n"]
79+
[23.735406, "o", "\u001b[?1h\u001b=\u001b[?25l"]
80+
[23.741281, "o", "\u001b[32;1m?\u001b[0m \u001b[1mJava\u001b[0m [Use arrows to move], type to filter\u001b[36C \u001b[96;1m❯\u001b[0m\u001b[96;1m 17\u001b[0m\u001b[75C 21\u001b[75C 22\u001b[3A\r"]
81+
[24.857926, "o", "\u001b[?1l\u001b>\u001b[?12l\u001b[?25h\u001b[K\r\r\n\u001b[K\r\r\n\u001b[K\r\r\n\u001b[K\u001b[3A"]
82+
[24.862329, "o", "\u001b[32;1m?\u001b[0m \u001b[1mJava\u001b[0m \u001b[34m17\u001b[0m\r\n"]
83+
[25.237, "o", "Extracted to /tmp/projects/demo\r\n"]
84+
[25.334323, "o", "\u001b[?2004h\u001b]0;localhost: /tmp/projects\u0007\u001b[01;32mlocalhost\u001b[00m:\u001b[01;34m/tmp/projects\u001b[00m$ "]
85+
[28.489663, "o", "l"]
86+
[28.982541, "o", "s"]
87+
[29.153306, "o", " "]
88+
[29.281033, "o", "d"]
89+
[29.488471, "o", "e"]
90+
[29.53939, "o", "m"]
91+
[29.621389, "o", "o"]
92+
[29.830295, "o", "\r\n"]
93+
[29.830337, "o", "\u001b[?2004l\r"]
94+
[29.833069, "o", "build.gradle \u001b[0m\u001b[01;34mgradle\u001b[0m \u001b[01;32mgradlew\u001b[0m gradlew.bat HELP.md settings.gradle \u001b[01;34msrc\u001b[0m\r\n"]
95+
[29.842404, "o", "\u001b[?2004h\u001b]0;localhost: /tmp/projects\u0007\u001b[01;32mlocalhost\u001b[00m:\u001b[01;34m/tmp/projects\u001b[00m$ "]

‎docs/modules/ROOT/nav.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@
44
* xref:key-concepts.adoc[Key Concepts]
55
* xref:ref/index.adoc[]
66
** xref:ref/project/index.adoc[]
7-
*** xref:ref/project/creating-new-projects.adoc[Creating New Projects]
87
*** xref:ref/project/comments-on-the-approach.adoc[Comments on the Approach]
8+
*** xref:ref/project/creating-new-projects.adoc[Creating New Projects]
99
*** xref:ref/project/adding-to-existing-projects.adoc[Adding to Existing Projects]
1010
** xref:ref/catalog/index.adoc[]
1111
*** xref:ref/catalog/registering-new-projects.adoc[]
@@ -21,5 +21,5 @@
2121
** xref:howto/boot-add-guide.adoc[Using "boot add"]
2222
** xref:howto/ai-guide.adoc[Guide to "ai Commands"]
2323
** xref:howto/special-commands-guide.adoc[Guide to Special Commands]
24-
** xref:howto/initializr.adoc[Guide to Initializr Commands]
24+
** xref:howto/create-application.adoc[]
2525
* xref:glossary.adoc[Glossary]

‎docs/modules/ROOT/pages/howto/create-application.adoc

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
= Create Application
2+
3+
This section includes topics relating to application creation.
4+
5+
[#initializr]
6+
== Create using start.spring.io
7+
8+
You can use Spring CLI as a client for https://start.spring.io.
9+
10+
Shell style project creation mimics how a project is created from the UI. The following image shows an example of it:
11+
12+
[asciinema,rows=19]
13+
----
14+
include::example$boot-start-interactive.cast[]
15+
----

‎docs/modules/ROOT/pages/howto/initializr.adoc

Lines changed: 0 additions & 244 deletions
This file was deleted.

‎docs/modules/ROOT/pages/ref/project/comments-on-the-approach.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ The Spring team has created two ways to create a new project and one way to modi
1212
== Initializr
1313

1414
The common way to create a new Spring Boot project has been to use Initializr, at https://start.spring.io.
15-
The Spring CLI provides you with a command to interact with Initializr. See xref:howto/initializr.adoc[Initializr] but also offers other approaches to creating a new project and addresses the `day-2` use case of adding code or configuration to an existing project.
15+
The Spring CLI provides you with a command to interact with Initializr. See xref:howto/create-application#initializr.adoc[Initializr] but also offers other approaches to creating a new project and addresses the `day-2` use case of adding code or configuration to an existing project.
1616

1717
[[comments-approach-boot-new]]
1818
== Using Boot New

0 commit comments

Comments
 (0)