Merge pull request #2181 from OctopusDeploy/tk/octo-cli-updates

Updates to Octo CLI and Octopus CLI pages

dictionary-octopus.txt

@@ -8,6 +8,7 @@ aspnetcore
 astro
 astrojs
 augeas
+autodeployoverride
 awsaccount
 azureaccount
 Bento
@@ -30,9 +31,9 @@ Cpath
 createartifact
 creds
 crossorigin
-Csvg
 cscfg
 cspkg
+Csvg
 cutover
 Datacenter
 datetime
@@ -43,6 +44,7 @@ deployers
 deploymentannotation
 deploymentprocess
 deploymentprocesses
+Directorygroup
 Distro
 Dockerfiles
 dockerhub
@@ -51,14 +53,15 @@ dpkg
 emptytitle
 Fargate
 feedcred
-FIPS
 fieldset
 figcaption
+FIPS
 frontmatter
 gcloud
 globbing
 googleaccount
 groff
+Groupsand
 healthcheck
 HKEY
 HKLM
@@ -75,15 +78,16 @@ inetsrv
 internalcustomer
 Istio
 istioctl
-ITSM
 itemprop
 itemscope
 itemtype
+ITSM
 jwks
 keyrings
 Kubelet
 kustomization
 kustomize
+latestdeployments
 libicu
 lifecycles
 linkerd
@@ -130,11 +134,13 @@ podannotation
 prerenderingchange
 printfn
 PROGRAMFILES
+pwsh
 pycryptodome
 querystring
 quickstart
 rehype
 reindexing
+releaseprogression
 remoting
 reprioritize
 reprovisioned
@@ -179,10 +185,9 @@ webserver
 WEBSVR
 WIXUI
 workerpool
+workerpools
 workertools
 xlarge
 xmark
 xvzf
 YOURAPIKEY
-Groupsand
-Directorygroup

src/pages/docs/octopus-rest-api/cli/index.md

@@ -1,10 +1,10 @@
 ---
 layout: src/layouts/Default.astro
 pubDate: 2023-01-01
-modDate: 2023-01-01
-title: CLI
+modDate: 2023-02-23
+title: Octopus Command Line (CLI)
 description: The all-new Octopus CLI
-navOrder: 100
+navOrder: 30
 hideInThisSection: true
 ---
 

src/pages/docs/octopus-rest-api/octopus-cli/index.mdx

@@ -1,16 +1,22 @@
 ---
 layout: src/layouts/Default.astro
 pubDate: 2023-01-01
-modDate: 2023-10-04
-title: The Octopus Command Line (CLI)
-description: The Octopus CLI (octo) is the Octopus command line tool that builds on top of the Octopus REST API.
-navOrder: 30
+modDate: 2023-02-23
+title: Octo Command Line (CLI)
+description: The Octo CLI is the Octopus command line tool that builds on top of the Octopus REST API.
+navOrder: 100
 hideInThisSection: true
 ---
 import OctopusCli from 'src/shared-content/concepts/octopus-cli.include.md';
-import OctoAutocompleteTabCompletion from 'src/shared-content/octopus-cli/octo-autocomplete-tabcompletion.include.md';
+import OctoAutocompleteTabCompletion from 'src/shared-content/octopus-cli/octo-autocomplete-tab-completion.include.md';
 
-<OctopusCli />
+:::div{.hint}
+The Octo CLI has been replaced by the <a href="/docs/octopus-rest-api/cli">new Octopus CLI</a>. We will no longer provide feature or security updates to the Octo CLI and we recommend making the swap to the new Octopus CLI as soon as it's practical to do so.
+:::
+
+The Octo CLI is a command line tool that builds on top of the [Octopus Deploy REST API](/docs/octopus-rest-api). With the Octo CLI you can package your applications for deployment as either Zip or NuGet packages, and manage your environments, deployments, channels, projects, and workers.
+
+The Octo CLI, which leans heavily on the [Octopus Clients library](https://github.com/OctopusDeploy/OctopusClients), is built and maintained by the Octopus Deploy team, but it is also open source. The Octo CLI can be used on Windows, Mac, Linux, Docker, and as a .NET Core global tool. For installation options and direct downloads, visit the [Octopus CLI Project on GitHub](https://github.com/OctopusDeploy/OctopusCli).
 
 ## Commands \{#octoCommandLine-Commands}
 

src/pages/docs/octopus-rest-api/octopus-cli/install-autocomplete.mdx

@@ -6,7 +6,7 @@ title: Install autocomplete
 description: Install a shell auto-complete script into your shell profile, if they aren't already there. Supports pwsh, zsh, bash & powershell.
 navOrder: 100
 ---
-import OctoAutocompleteTabCompletion from 'src/shared-content/octopus-cli/octo-autocomplete-tabcompletion.include.md';
+import OctoAutocompleteTabCompletion from 'src/shared-content/octopus-cli/octo-autocomplete-tab-completion.include.md';
 
 Install a shell auto-complete script into your shell profile, if they aren't already there. Supports pwsh, zsh, bash, and PowerShell.
 

src/shared-content/octopus-cli/octo-autocomplete-tabcompletion.include.md → src/shared-content/octopus-cli/octo-autocomplete-tab-completion.include.md

@@ -53,6 +53,6 @@ octo install-autocomplete --shell powershell --dryRun
 
 </details>
 
-4. You can now discover sub-commands by typing `octo [searchterm]` and hitting the [tab] key. If you don't provide a search term, the full list of available sub-commands will be shown.
+4. You can now discover sub-commands by typing `octo [search-term]` and hitting the [tab] key. If you don't provide a search term, the full list of available sub-commands will be shown.
 
 ![animation showing the tab completion feature in Zsh to list all environments in the default space](/docs/shared-content/images/autocomplete.gif)