\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{adik311} \pdfinfo{ /Title (salesforce-cli-command-reference.pdf) /Creator (Cheatography) /Author (adik311) /Subject (Salesforce CLI Command Reference 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}{0D9DDA} \definecolor{LightBackground}{HTML}{EFF8FC} \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{Salesforce CLI Command Reference Cheat Sheet}}}} \\ \normalsize{by \textcolor{DarkBackground}{adik311} via \textcolor{DarkBackground}{\uline{cheatography.com/196812/cs/41397/}}} \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}adik311 \\ \uline{cheatography.com/adik311} \\ \end{tabulary} \vfill \columnbreak \begin{tabulary}{5.8cm}{L} \SetRowColor{FootBackground} \mymulticolumn{1}{p{5.377cm}}{\bf\textcolor{white}{Cheat Sheet}} \\ \vspace{-2pt}Not Yet Published.\\ Updated 8th 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{multicols*}{2} \begin{tabularx}{8.4cm}{x{4 cm} x{4 cm} } \SetRowColor{DarkBackground} \mymulticolumn{2}{x{8.4cm}}{\bf\textcolor{white}{sf alias}} \tn % Row 0 \SetRowColor{LightBackground} {\bf{sf alias list}} & List all aliases currently set on your local computer. \tn % Row Count 3 (+ 3) % Row 1 \SetRowColor{white} {\bf{sf alias set}} {\emph{alias}}={\emph{'value'}} & Set one or more aliases on your local computer. \tn % Row Count 6 (+ 3) % Row 2 \SetRowColor{LightBackground} {\bf{sf alias unset}} {\emph{alias}} {\emph{my-other-alias}} & Unset one or more aliases that are currently set on your local computer. \tn % Row Count 10 (+ 4) \hhline{>{\arrayrulecolor{DarkBackground}}--} \SetRowColor{LightBackground} \mymulticolumn{2}{x{8.4cm}}{{\emph{{[}-a|-all{]}}} : Unset all currently set aliases. \newline {\emph{{[}-p|-{}-no-prompt{]}}} : Don't prompt the user for confirmation when unsetting all alliases.} \tn \hhline{>{\arrayrulecolor{DarkBackground}}--} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{8.4cm}{x{4 cm} x{4 cm} } \SetRowColor{DarkBackground} \mymulticolumn{2}{x{8.4cm}}{\bf\textcolor{white}{sf config}} \tn % Row 0 \SetRowColor{LightBackground} {\bf{sf config get}} {\emph{CONFIG\_VARIABLE}} {\emph{{[}-{}-verbose{]}}} & Get the value of a configuration variable.\{\{nl\}\}{\emph{-{}-verbose}} : Display whether the configuration variables are set locally or globally. \tn % Row Count 7 (+ 7) % Row 1 \SetRowColor{white} {\bf{sf config list}} & List the configuration variables that you've previously set. \tn % Row Count 10 (+ 3) % Row 2 \SetRowColor{LightBackground} {\bf{sf config set}} {\emph{CONFIG\_VARIABLE=NEW\_VALUE}} {\emph{{[}-g|-{}-global{]}}} & Set one or more configuration variables, such as your default org.\{\{nl\}\}{\emph{{[}-g|-{}-global{]}}} : Set the configuration variables globally, so they can be used from any Salesforce DX project. \tn % Row Count 20 (+ 10) % Row 3 \SetRowColor{white} {\bf{sf config unset}} {\emph{CONFIG\_VARIABLE}} {\emph{{[}-g|-{}-global{]}}} & Unset local or global configuration variables.\{\{nl\}\}{\emph{{[}-g|-{}-global{]}}} : Unset the configuration variables globally. \tn % Row Count 26 (+ 6) \hhline{>{\arrayrulecolor{DarkBackground}}--} \SetRowColor{LightBackground} \mymulticolumn{2}{x{8.4cm}}{{\emph{CONFIG\_VARIABLE}} can be multiple variables separated by space, e.g., {\emph{target-org api-version}}.} \tn \hhline{>{\arrayrulecolor{DarkBackground}}--} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{8.4cm}{x{2.4 cm} x{5.6 cm} } \SetRowColor{DarkBackground} \mymulticolumn{2}{x{8.4cm}}{\bf\textcolor{white}{Configuration Variables}} \tn % Row 0 \SetRowColor{LightBackground} \seqsplit{`org-api-version`} & The API version for a specific project or all projects. Normally, Salesforce CLI assumes that you're using the same version of the CLI as the Dev Hub org. \tn % Row Count 6 (+ 6) % Row 1 \SetRowColor{white} \seqsplit{`target-org`} & The username or alias for an org that all commands run against by default. \tn % Row Count 9 (+ 3) % Row 2 \SetRowColor{LightBackground} \seqsplit{`target-dev-hub`} & The username or alias for your default Dev Hub org. \tn % Row Count 11 (+ 2) \hhline{>{\arrayrulecolor{DarkBackground}}--} \SetRowColor{LightBackground} \mymulticolumn{2}{x{8.4cm}}{\{\{link="https://developer.salesforce.com/docs/atlas.en-us.sfdx\_setup.meta/sfdx\_setup/sfdx\_dev\_cli\_config\_values.htm"\}\}Salesforce CLI Setup Guide: Configuration Variables\{\{/link\}\}} \tn \hhline{>{\arrayrulecolor{DarkBackground}}--} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{8.4cm}{x{3.12 cm} x{4.88 cm} } \SetRowColor{DarkBackground} \mymulticolumn{2}{x{8.4cm}}{\bf\textcolor{white}{sf org create}} \tn % Row 0 \SetRowColor{LightBackground} {\bf{sf org create sandbox}} & Create a sandbox org. \tn % Row Count 2 (+ 2) % Row 1 \SetRowColor{white} {\bf{sf org create scratch}} & Create a scratch org \tn % Row Count 4 (+ 2) % Row 2 \SetRowColor{LightBackground} {\bf{sf org create shape}} & Create a scratch org configuration (shape) based on the specified source org. \tn % Row Count 8 (+ 4) % Row 3 \SetRowColor{white} {\bf{sf org create snapshot}} & Create a snapshot of a scratch org. \tn % Row Count 10 (+ 2) % Row 4 \SetRowColor{LightBackground} {\bf{sf org create user}} & Create a user for a scratch org. \tn % Row Count 12 (+ 2) \hhline{>{\arrayrulecolor{DarkBackground}}--} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{8.4cm}{x{3.2 cm} x{4.8 cm} } \SetRowColor{DarkBackground} \mymulticolumn{2}{x{8.4cm}}{\bf\textcolor{white}{sf project deploy {[}{[}WIP{]}{]}}} \tn % Row 0 \SetRowColor{LightBackground} {\bf{project deploy preview}} & Preview a deployment to see what will deploy to the org, the potential conflicts, and the ignored files. \tn % Row Count 5 (+ 5) % Row 1 \SetRowColor{white} {\bf{project deploy start}} & Deploy metadata to an org from your local project. \tn % Row Count 8 (+ 3) % Row 2 \SetRowColor{LightBackground} {\bf{project deploy validate}} & Validate a metadata deployment without actually executing it. \tn % Row Count 11 (+ 3) % Row 3 \SetRowColor{white} {\bf{project deploy resume}} & Resume watching a deploy operation and update source tracking when the deploy completes. \tn % Row Count 15 (+ 4) % Row 4 \SetRowColor{LightBackground} {\bf{project deploy cancel}} & Cancel a deploy operation. \tn % Row Count 17 (+ 2) \hhline{>{\arrayrulecolor{DarkBackground}}--} \SetRowColor{LightBackground} \mymulticolumn{2}{x{8.4cm}}{{\bf{ {\emph{ Universal attributes: }} }} \newline {\emph{{[}-o|-{}-target-org{]}}} : Username or alias of the target org. \newline \newline \{\{link="https://developer.salesforce.com/docs/atlas.en-us.sfdx\_cli\_reference.meta/sfdx\_cli\_reference/cli\_reference\_project\_commands\_unified.htm"\}\}Salesforce CLI Command Reference: project Commands \newline \{\{/link\}\}} \tn \hhline{>{\arrayrulecolor{DarkBackground}}--} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{8.4cm}{x{3.52 cm} x{4.48 cm} } \SetRowColor{DarkBackground} \mymulticolumn{2}{x{8.4cm}}{\bf\textcolor{white}{sf org login}} \tn % Row 0 \SetRowColor{LightBackground} {\bf{sf org login access-token}} & Authorize an org using an existing Salesforce access token. \tn % Row Count 3 (+ 3) % Row 1 \SetRowColor{white} {\emph{-r|-{}-instance-url INSTANCE-URL}} & URL of the instance that the org lives on.\{\{nl\}\}If you specify an -{}-instance-url value, this value overrides the sfdcLoginUrl value in your sfdx-project.json file.\{\{nl\}\}To specify a My Domain URL, use the format "https://\textless{}MyDomainName\textgreater{}.my.salesforce.com".\{\{nl\}\}To specify a sandbox, set -{}-instance-url to "https://\textless{}MyDomainName\textgreater{}-{}-\textless{}SandboxName\textgreater{}.sandbox.my.salesforce.com". \tn % Row Count 20 (+ 17) % Row 2 \SetRowColor{LightBackground} {\bf{sf org login device}} & Authorize an org using a device code. \tn % Row Count 22 (+ 2) % Row 3 \SetRowColor{white} {\bf{sf org login jwt}} & Log in to a Salesforce org using a JSON web token (JWT). \tn % Row Count 25 (+ 3) % Row 4 \SetRowColor{LightBackground} {\bf{sf org login sfdx-url}} & Authorize an org using a Salesforce DX authorization URL stored in a file or through standard input (stdin). \tn % Row Count 30 (+ 5) \end{tabularx} \par\addvspace{1.3em} \vfill \columnbreak \begin{tabularx}{8.4cm}{x{3.52 cm} x{4.48 cm} } \SetRowColor{DarkBackground} \mymulticolumn{2}{x{8.4cm}}{\bf\textcolor{white}{sf org login (cont)}} \tn % Row 5 \SetRowColor{LightBackground} {\bf{sf org login web}} & Log in to a Salesforce org using the web server flow. \tn % Row Count 3 (+ 3) \hhline{>{\arrayrulecolor{DarkBackground}}--} \SetRowColor{LightBackground} \mymulticolumn{2}{x{8.4cm}}{{\bf{ {\emph{ Universal attributes: }} }} \newline {\emph{{[}-a|-{}-alias{]}}} : Alias for the org. \newline {\emph{{[}-s|-{}-set-default{]}}} : Set the authenticated org as the default that all org-related commands run against. \newline {\emph{{[}-d|-{}-set-default-dev-hub{]}}} : Set the authenticated org as the default Dev Hub.} \tn \hhline{>{\arrayrulecolor{DarkBackground}}--} \end{tabularx} \par\addvspace{1.3em} % That's all folks \end{multicols*} \end{document}