\documentclass[10pt,a4paper]{article} % Packages \usepackage{fancyhdr} % For header and footer \usepackage{multicol} % Allows multicols in tables \usepackage{tabularx} % Intelligent column widths \usepackage{tabulary} % Used in header and footer \usepackage{hhline} % Border under tables \usepackage{graphicx} % For images \usepackage{xcolor} % For hex colours %\usepackage[utf8x]{inputenc} % For unicode character support \usepackage[T1]{fontenc} % Without this we get weird character replacements \usepackage{colortbl} % For coloured tables \usepackage{setspace} % For line height \usepackage{lastpage} % Needed for total page number \usepackage{seqsplit} % Splits long words. %\usepackage{opensans} % Can't make this work so far. Shame. Would be lovely. \usepackage[normalem]{ulem} % For underlining links % Most of the following are not required for the majority % of cheat sheets but are needed for some symbol support. \usepackage{amsmath} % Symbols \usepackage{MnSymbol} % Symbols \usepackage{wasysym} % Symbols %\usepackage[english,german,french,spanish,italian]{babel} % Languages % Document Info \author{Nehemiah (nehem87)} \pdfinfo{ /Title (sitecore-xm-cloud-cli-commands-list.pdf) /Creator (Cheatography) /Author (Nehemiah (nehem87)) /Subject (Sitecore XM Cloud CLI Commands List Cheat Sheet) } % Lengths and widths \addtolength{\textwidth}{6cm} \addtolength{\textheight}{-1cm} \addtolength{\hoffset}{-3cm} \addtolength{\voffset}{-2cm} \setlength{\tabcolsep}{0.2cm} % Space between columns \setlength{\headsep}{-12pt} % Reduce space between header and content \setlength{\headheight}{85pt} % If less, LaTeX automatically increases it \renewcommand{\footrulewidth}{0pt} % Remove footer line \renewcommand{\headrulewidth}{0pt} % Remove header line \renewcommand{\seqinsert}{\ifmmode\allowbreak\else\-\fi} % Hyphens in seqsplit % This two commands together give roughly % the right line height in the tables \renewcommand{\arraystretch}{1.3} \onehalfspacing % Commands \newcommand{\SetRowColor}[1]{\noalign{\gdef\RowColorName{#1}}\rowcolor{\RowColorName}} % Shortcut for row colour \newcommand{\mymulticolumn}[3]{\multicolumn{#1}{>{\columncolor{\RowColorName}}#2}{#3}} % For coloured multi-cols \newcolumntype{x}[1]{>{\raggedright}p{#1}} % New column types for ragged-right paragraph columns \newcommand{\tn}{\tabularnewline} % Required as custom column type in use % Font and Colours \definecolor{HeadBackground}{HTML}{333333} \definecolor{FootBackground}{HTML}{666666} \definecolor{TextColor}{HTML}{333333} \definecolor{DarkBackground}{HTML}{611616} \definecolor{LightBackground}{HTML}{FAF7F7} \renewcommand{\familydefault}{\sfdefault} \color{TextColor} % Header and Footer \pagestyle{fancy} \fancyhead{} % Set header to blank \fancyfoot{} % Set footer to blank \fancyhead[L]{ \noindent \begin{multicols}{3} \begin{tabulary}{5.8cm}{C} \SetRowColor{DarkBackground} \vspace{-7pt} {\parbox{\dimexpr\textwidth-2\fboxsep\relax}{\noindent \hspace*{-6pt}\includegraphics[width=5.8cm]{/web/www.cheatography.com/public/images/cheatography_logo.pdf}} } \end{tabulary} \columnbreak \begin{tabulary}{11cm}{L} \vspace{-2pt}\large{\bf{\textcolor{DarkBackground}{\textrm{Sitecore XM Cloud CLI Commands List Cheat Sheet}}}} \\ \normalsize{by \textcolor{DarkBackground}{Nehemiah (nehem87)} via \textcolor{DarkBackground}{\uline{cheatography.com/192697/cs/40068/}}} \end{tabulary} \end{multicols}} \fancyfoot[L]{ \footnotesize \noindent \begin{multicols}{3} \begin{tabulary}{5.8cm}{LL} \SetRowColor{FootBackground} \mymulticolumn{2}{p{5.377cm}}{\bf\textcolor{white}{Cheatographer}} \\ \vspace{-2pt}Nehemiah (nehem87) \\ \uline{cheatography.com/nehem87} \\ \end{tabulary} \vfill \columnbreak \begin{tabulary}{5.8cm}{L} \SetRowColor{FootBackground} \mymulticolumn{1}{p{5.377cm}}{\bf\textcolor{white}{Cheat Sheet}} \\ \vspace{-2pt}Published 30th August, 2023.\\ Updated 23rd October, 2024.\\ Page {\thepage} of \pageref{LastPage}. \end{tabulary} \vfill \columnbreak \begin{tabulary}{5.8cm}{L} \SetRowColor{FootBackground} \mymulticolumn{1}{p{5.377cm}}{\bf\textcolor{white}{Sponsor}} \\ \SetRowColor{white} \vspace{-5pt} %\includegraphics[width=48px,height=48px]{dave.jpeg} Measure your website readability!\\ www.readability-score.com \end{tabulary} \end{multicols}} \begin{document} \raggedright \raggedcolumns % Set font size to small. Switch to any value % from this page to resize cheat sheet text: % www.emerson.emory.edu/services/latex/latex_169.html \footnotesize % Small font. \begin{tabularx}{17.67cm}{x{8.635 cm} x{8.635 cm} } \SetRowColor{DarkBackground} \mymulticolumn{2}{x{17.67cm}}{\bf\textcolor{white}{Sitecore CLI and Plugin Installation}} \tn % Row 0 \SetRowColor{LightBackground} Create/Navigate Project Folder & \{\{noshy\}\}cd \textless{}project folder\textgreater{}\{\{noshy\}\} \tn % Row Count 2 (+ 2) % Row 1 \SetRowColor{white} Create DotNet Tool Manifest & \{\{noshy\}\}dotnet new tool-manifest\{\{noshy\}\} \tn % Row Count 5 (+ 3) % Row 2 \SetRowColor{LightBackground} Add Nuget Source & dotnet nuget add source -n Sitecore \{\{noshy\}\}\{\{link="https://nuget.sitecore.com/resources/v3/index.json"\}\}https://nuget.sitecore.com/resources/v3/index.json\{\{/link\}\}\{\{noshy\}\} \tn % Row Count 14 (+ 9) % Row 3 \SetRowColor{white} Install Sitecore.CLI Tool & \{\{noshy\}\}dotnet tool install Sitecore.CLI\{\{noshy\}\} \tn % Row Count 17 (+ 3) % Row 4 \SetRowColor{LightBackground} To initialize New Project & dotnet sitecore init \tn % Row Count 19 (+ 2) % Row 5 \SetRowColor{white} Install the XM Cloud plugin (Requires Sitecore CLI version 5.0.0 and later) & \{\{noshy\}\}dotnet sitecore plugin add -n \seqsplit{Sitecore.DevEx.Extensibility}.XMCloud\{\{noshy\}\} \tn % Row Count 24 (+ 5) % Row 6 \SetRowColor{LightBackground} To view plugins \seqsplit{installed/initialized} & dotnet sitecore plugin list \tn % Row Count 26 (+ 2) \hhline{>{\arrayrulecolor{DarkBackground}}--} \SetRowColor{LightBackground} \mymulticolumn{2}{x{17.67cm}}{Installing Sitecore CLI} \tn \hhline{>{\arrayrulecolor{DarkBackground}}--} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{17.67cm}{x{1.8117 cm} x{2.3058 cm} x{6.2586 cm} x{6.0939 cm} } \SetRowColor{DarkBackground} \mymulticolumn{4}{x{17.67cm}}{\bf\textcolor{white}{XM Cloud Plugin Commands}} \tn % Row 0 \SetRowColor{LightBackground} \mymulticolumn{4}{x{17.67cm}}{List of all the commands, subcommands.} \tn % Row Count 1 (+ 1) % Row 1 \SetRowColor{white} Login & \seqsplit{interactive} & For interactive user login using a device code authentication flow & \{\{noshy\}\}dotnet sitecore cloud login\{\{noshy\}\} \tn % Row Count 6 (+ 5) % Row 2 \SetRowColor{LightBackground} Login & \seqsplit{non-interactive} & For \seqsplit{non-interactive} client logins using client credential flows & \{\{noshy\}\}dotnet sitecore cloud login -{}-client-credentials -{}-client-id \textless{}clientId\textgreater{} -{}-client-secret \textless{}clientSecret\textgreater{}\{\{noshy\}\} \tn % Row Count 15 (+ 9) % Row 3 \SetRowColor{white} \seqsplit{Logout} & \seqsplit{logout} & To log out of an XM Cloud environment & \{\{noshy\}\}dotnet sitecore cloud logout\{\{noshy\}\} \tn % Row Count 19 (+ 4) % Row 4 \SetRowColor{LightBackground} \seqsplit{Organization} & info & To show information about the current user's organization & \{\{noshy\}\}dotnet sitecore cloud organization info -{}-organization-id \textless{}id\textgreater{}\{\{noshy\}\} \tn % Row Count 25 (+ 6) % Row 5 \SetRowColor{white} \seqsplit{Organization} & \seqsplit{health} & To provide information about the status of the organization's resources. & \{\{noshy\}\}dotnet sitecore cloud organization health -{}-organization-id \textless{}id\textgreater{}\{\{noshy\}\} \tn % Row Count 31 (+ 6) \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{17.67cm}{x{1.8117 cm} x{2.3058 cm} x{6.2586 cm} x{6.0939 cm} } \SetRowColor{DarkBackground} \mymulticolumn{4}{x{17.67cm}}{\bf\textcolor{white}{XM Cloud Plugin Commands (cont)}} \tn % Row 6 \SetRowColor{LightBackground} \seqsplit{Organization} & \seqsplit{license} & To download your organization's license file using the license subcommand & \{\{noshy\}\}dotnet sitecore cloud organization license -{}-organization-id \textless{}id\textgreater{}\{\{noshy\}\} \tn % Row Count 6 (+ 6) % Row 7 \SetRowColor{white} \seqsplit{Project} & list & To get the list of all XM Cloud Projects & \{\{noshy\}\}dotnet sitecore cloud project list\{\{noshy\}\} \tn % Row Count 10 (+ 4) % Row 8 \SetRowColor{LightBackground} \seqsplit{Project} & info & To get information about an XM Cloud Project & \{\{noshy\}\}dotnet sitecore cloud project info -{}-project-id \textless{}project-id\textgreater{}\{\{noshy\}\} \tn % Row Count 16 (+ 6) % Row 9 \SetRowColor{white} \seqsplit{Project} & \seqsplit{create} & To create an XM Cloud Project & \{\{noshy\}\}dotnet sitecore cloud project create -{}-name "Project name"\{\{noshy\}\} \tn % Row Count 22 (+ 6) % Row 10 \SetRowColor{LightBackground} \seqsplit{Project} & \seqsplit{update} & To update the name of the XM Cloud Project & \{\{noshy\}\}dotnet sitecore cloud project update -{}-project-id \textless{}project-id\textgreater{} -{}-name "Updated Name"\{\{noshy\}\} \tn % Row Count 30 (+ 8) \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{17.67cm}{x{1.8117 cm} x{2.3058 cm} x{6.2586 cm} x{6.0939 cm} } \SetRowColor{DarkBackground} \mymulticolumn{4}{x{17.67cm}}{\bf\textcolor{white}{XM Cloud Plugin Commands (cont)}} \tn % Row 11 \SetRowColor{LightBackground} \seqsplit{Project} & \seqsplit{delete} & To remove an XM Cloud project & \{\{noshy\}\}dotnet sitecore cloud project delete -{}-project-id \textless{}project-id\textgreater{}\{\{noshy\}\} \tn % Row Count 6 (+ 6) % Row 12 \SetRowColor{white} \seqsplit{Environment} & list & To list all the XM Cloud environments for a project & \{\{noshy\}\}dotnet sitecore cloud environment list -{}-project-id \textless{}project ID\textgreater{}\{\{noshy\}\} \tn % Row Count 12 (+ 6) % Row 13 \SetRowColor{LightBackground} \seqsplit{Environment} & info & To get information about an XM Cloud Environment & \{\{noshy\}\}dotnet sitecore cloud environment info -{}-environment-id \textless{}environment-id\textgreater{}\{\{noshy\}\} \tn % Row Count 19 (+ 7) % Row 14 \SetRowColor{white} \seqsplit{Environment} & \seqsplit{create} & To create a new XM Cloud environment & \{\{noshy\}\}dotnet sitecore cloud environment create -{}-name "Staging" -{}-project-id \textless{}project-id\textgreater{}\{\{noshy\}\} \tn % Row Count 27 (+ 8) % Row 15 \SetRowColor{LightBackground} \seqsplit{Environment} & \seqsplit{update} & To update an existing XM Cloud environment & \{\{noshy\}\}dotnet sitecore cloud environment update -{}-environment-id \textless{}env-id\textgreater{} -{}-name "Updated Name"\{\{noshy\}\} \tn % Row Count 35 (+ 8) \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{17.67cm}{x{1.8117 cm} x{2.3058 cm} x{6.2586 cm} x{6.0939 cm} } \SetRowColor{DarkBackground} \mymulticolumn{4}{x{17.67cm}}{\bf\textcolor{white}{XM Cloud Plugin Commands (cont)}} \tn % Row 16 \SetRowColor{LightBackground} \seqsplit{Environment} & \seqsplit{delete} & To remove an XM Cloud environment & \{\{noshy\}\}dotnet sitecore cloud environment delete -{}-environment-id \textless{}environment-id\textgreater{}\{\{noshy\}\} \tn % Row Count 7 (+ 7) % Row 17 \SetRowColor{white} \seqsplit{Environment} & \seqsplit{connect} & To connect your Sitecore solution to an existing environment & \{\{noshy\}\}dotnet sitecore cloud environment connect -{}-environment-id \textless{}environment-id\textgreater{}\{\{noshy\}\} \tn % Row Count 14 (+ 7) % Row 18 \SetRowColor{LightBackground} \seqsplit{Environment} & \seqsplit{disconnect} & To disconnect your Sitecore solution from an existing environment & \{\{noshy\}\}sitecore cloud environment disconnect -{}-environment-id \textless{}environment-id\textgreater{}\{\{noshy\}\} \tn % Row Count 21 (+ 7) % Row 19 \SetRowColor{white} \seqsplit{Environment} & \seqsplit{promote} & To promote an existing deployment into a specific environment & \{\{noshy\}\}sitecore cloud environment promote -{}-environment-id \textless{}environment-id\textgreater{} -{}-source-id \textless{}deployment-id\textgreater{}\{\{noshy\}\} \tn % Row Count 30 (+ 9) \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{17.67cm}{x{1.8117 cm} x{2.3058 cm} x{6.2586 cm} x{6.0939 cm} } \SetRowColor{DarkBackground} \mymulticolumn{4}{x{17.67cm}}{\bf\textcolor{white}{XM Cloud Plugin Commands (cont)}} \tn % Row 20 \SetRowColor{LightBackground} \seqsplit{Environment} & log list & To list the log file names from the deployment & \{\{noshy\}\}dotnet sitecore cloud environment log list -{}-environment-id \textless{}env-id\textgreater{}\{\{noshy\}\} \tn % Row Count 7 (+ 7) % Row 21 \SetRowColor{white} \seqsplit{Environment} & log \seqsplit{download} & To download and save the content of the specified log file & \{\{noshy\}\}dotnet sitecore cloud environment log download -{}-environment-id \textless{}env-id\textgreater{} -{}-logfile \textless{}logfile\textgreater{}\{\{noshy\}\} \tn % Row Count 15 (+ 8) % Row 22 \SetRowColor{LightBackground} \seqsplit{Environment} & log view & To download and print the content of the specified log file to the console & \{\{noshy\}\}dotnet sitecore cloud environment log view -{}-environment-id \textless{}env-id\textgreater{} -{}-logfile \textless{}logfile\textgreater{}\{\{noshy\}\} \tn % Row Count 23 (+ 8) % Row 23 \SetRowColor{white} \seqsplit{Environment} & \seqsplit{health} & To display the health status of an environment's resources & \{\{noshy\}\}dotnet sitecore cloud environment health -{}-environment-id \textless{}environment-id\textgreater{}\{\{noshy\}\} \tn % Row Count 30 (+ 7) \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{17.67cm}{x{1.8117 cm} x{2.3058 cm} x{6.2586 cm} x{6.0939 cm} } \SetRowColor{DarkBackground} \mymulticolumn{4}{x{17.67cm}}{\bf\textcolor{white}{XM Cloud Plugin Commands (cont)}} \tn % Row 24 \SetRowColor{LightBackground} \seqsplit{Environment} & \seqsplit{variable} list & To list all the environment variables for an XM Cloud environment & \{\{noshy\}\}dotnet sitecore cloud environment variable list -{}-environment-id \textless{}environment-id\textgreater{}\{\{noshy\}\} \tn % Row Count 8 (+ 8) % Row 25 \SetRowColor{white} \seqsplit{Environment} & \seqsplit{variable} \seqsplit{upsert} & To create or update environment variables for an XM Cloud environment & \{\{noshy\}\}dotnet sitecore cloud environment variable upsert -{}-environment-id env1 -{}-name testvar -{}-value testval -{}-target CM 'testvar'\{\{noshy\}\} \tn % Row Count 19 (+ 11) % Row 26 \SetRowColor{LightBackground} \seqsplit{Environment} & \seqsplit{variable} \seqsplit{delete} & To delete the specified environment variable from an XM Cloud environment & \{\{noshy\}\}dotnet sitecore cloud environment variable delete -{}-environment-id env1 -{}-name testvar 'testvar'\{\{noshy\}\} \tn % Row Count 28 (+ 9) % Row 27 \SetRowColor{white} \seqsplit{Environment} & \seqsplit{restart} & To restart the authoring environment without downtime. & \{\{noshy\}\}dotnet sitecore cloud environment restart -{}-environment-id \textless{}environment-id\textgreater{}\{\{noshy\}\} \tn % Row Count 35 (+ 7) \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{17.67cm}{x{1.8117 cm} x{2.3058 cm} x{6.2586 cm} x{6.0939 cm} } \SetRowColor{DarkBackground} \mymulticolumn{4}{x{17.67cm}}{\bf\textcolor{white}{XM Cloud Plugin Commands (cont)}} \tn % Row 28 \SetRowColor{LightBackground} \seqsplit{Deployment} & \seqsplit{create} & To create and start a deployment entity for an XM Cloud environment & \{\{noshy\}\}dotnet sitecore cloud deployment create -{}-environment-id \textless{}id\textgreater{} -{}-no-start -{}-no-watch -{}-upload -{}-working-dir \textless{}path\textgreater{}\{\{noshy\}\} \tn % Row Count 10 (+ 10) % Row 29 \SetRowColor{white} \seqsplit{Deployment} & info & To get information about a specific XM Cloud deployment & \{\{noshy\}\}dotnet sitecore cloud deployment get -{}-deployment-id \textless{}id\textgreater{}\{\{noshy\}\} \tn % Row Count 16 (+ 6) % Row 30 \SetRowColor{LightBackground} \seqsplit{Deployment} & list & To list the most recent deployments for an environment & \{\{noshy\}\}dotnet sitecore cloud deployment list -{}-environment-id \textless{}id\textgreater{}\{\{noshy\}\} \tn % Row Count 22 (+ 6) % Row 31 \SetRowColor{white} \seqsplit{Deployment} & start & To start the execution of a deployment & \{\{noshy\}\}dotnet sitecore cloud deployment start -{}-deployment-id \textless{}id\textgreater{} -{}-no-watch\{\{noshy\}\} \tn % Row Count 29 (+ 7) % Row 32 \SetRowColor{LightBackground} \seqsplit{Deployment} & watch & To show information about the deployment \seqsplit{status/progress} & \{\{noshy\}\}dotnet sitecore cloud deployment watch -{}-deployment-id \textless{}id\textgreater{}\{\{noshy\}\} \tn % Row Count 35 (+ 6) \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{17.67cm}{x{1.8117 cm} x{2.3058 cm} x{6.2586 cm} x{6.0939 cm} } \SetRowColor{DarkBackground} \mymulticolumn{4}{x{17.67cm}}{\bf\textcolor{white}{XM Cloud Plugin Commands (cont)}} \tn % Row 33 \SetRowColor{LightBackground} \seqsplit{Deployment} & log & To show or download logs about a specific deployment & \{\{noshy\}\}dotnet sitecore cloud deployment log -{}-deployment-id \textless{}id\textgreater{} -{}-output \textless{}path\textgreater{}\{\{noshy\}\} \tn % Row Count 7 (+ 7) \hhline{>{\arrayrulecolor{DarkBackground}}----} \end{tabularx} \par\addvspace{1.3em} \end{document}