\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{linux\_china} \pdfinfo{ /Title (dotenvx.pdf) /Creator (Cheatography) /Author (linux\_china) /Subject (dotenvx 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}{A3A3A3} \definecolor{LightBackground}{HTML}{F3F3F3} \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{dotenvx Cheat Sheet}}}} \\ \normalsize{by \textcolor{DarkBackground}{linux\_china} via \textcolor{DarkBackground}{\uline{cheatography.com/141366/cs/46785/}}} \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}linux\_china \\ \uline{cheatography.com/linux-china} \\ \end{tabulary} \vfill \columnbreak \begin{tabulary}{5.8cm}{L} \SetRowColor{FootBackground} \mymulticolumn{1}{p{5.377cm}}{\bf\textcolor{white}{Cheat Sheet}} \\ \vspace{-2pt}Published 24th July, 2025.\\ Updated 1st September, 2025.\\ 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{3.04 cm} x{4.96 cm} } \SetRowColor{DarkBackground} \mymulticolumn{2}{x{8.4cm}}{\bf\textcolor{white}{Create/List key pairs}} \tn % Row 0 \SetRowColor{LightBackground} dotenvx init & Create .env and .env.keys in current directory \tn % Row Count 2 (+ 2) % Row 1 \SetRowColor{white} dotenv -p test init & Create .env.test and .env.keys for test profile \tn % Row Count 4 (+ 2) % Row 2 \SetRowColor{LightBackground} dotenvx init -g & Create \$HOME/.env.keys for global profiles \tn % Row Count 6 (+ 2) % Row 3 \SetRowColor{white} dotenvx keypair & Validate and print key pair for .env \tn % Row Count 8 (+ 2) % Row 4 \SetRowColor{LightBackground} dotenvx -p test keypair & Validate ad print key pair for .env.test \tn % Row Count 10 (+ 2) % Row 5 \SetRowColor{white} dotenvx keypair -{}-all & List all global key pairs \tn % Row Count 12 (+ 2) % Row 6 \SetRowColor{LightBackground} dotenvx keypair -{}-import & Import private key \tn % Row Count 14 (+ 2) \hhline{>{\arrayrulecolor{DarkBackground}}--} \SetRowColor{LightBackground} \mymulticolumn{2}{x{8.4cm}}{Please use 'cargo binstall dotenvx-rs' to install dotenvx or download it from \seqsplit{https://github.com/linux-china/dotenvx-rs/releases}} \tn \hhline{>{\arrayrulecolor{DarkBackground}}--} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{8.4cm}{x{3.04 cm} x{4.96 cm} } \SetRowColor{DarkBackground} \mymulticolumn{2}{x{8.4cm}}{\bf\textcolor{white}{encrypt and decrypt for .env files}} \tn % Row 0 \SetRowColor{LightBackground} dotenvx encrypt & Encrypt .env file \tn % Row Count 1 (+ 1) % Row 1 \SetRowColor{white} dotenvx -p test encrypt & Encrypt .env.test file \tn % Row Count 3 (+ 2) % Row 2 \SetRowColor{LightBackground} dotenvx encrypt -{}-sign & Encrypt and sign .env file \tn % Row Count 5 (+ 2) % Row 3 \SetRowColor{white} dotenvx verify & Verify the .env file with public key and sign header in the file \tn % Row Count 8 (+ 3) % Row 4 \SetRowColor{LightBackground} dotenvx decrypt & Decrypt .env file \tn % Row Count 9 (+ 1) % Row 5 \SetRowColor{white} dotenvx -p test decrypt & Decrypt .env.test file \tn % Row Count 11 (+ 2) % Row 6 \SetRowColor{LightBackground} dotenvx decrypt -{}-stdout & Read .env file and print the decrypted items to stdout \tn % Row Count 14 (+ 3) % Row 7 \SetRowColor{white} dotenvx decrypt -{}-dump & Decrypt .env file and output entries to stdout with JSON format \tn % Row Count 17 (+ 3) \hhline{>{\arrayrulecolor{DarkBackground}}--} \SetRowColor{LightBackground} \mymulticolumn{2}{x{8.4cm}}{You can sign an .env file. If somebody modify the .env file, and verification will be failed.} \tn \hhline{>{\arrayrulecolor{DarkBackground}}--} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{8.4cm}{x{3.36 cm} x{4.64 cm} } \SetRowColor{DarkBackground} \mymulticolumn{2}{x{8.4cm}}{\bf\textcolor{white}{SDKs \& CLIs with Dotenvx}} \tn % Row 0 \SetRowColor{LightBackground} dotenvx link \seqsplit{.venv/bin/python} & Generate python interpreter with Dotenvx support \tn % Row Count 3 (+ 3) % Row 1 \SetRowColor{white} dotenvx link bin/mysql & Generate mysql cli with `.env` setup \tn % Row Count 5 (+ 2) % Row 2 \SetRowColor{LightBackground} dotenvx link bin/psql & Generate psql cli with `.env` setup \tn % Row Count 7 (+ 2) % Row 3 \SetRowColor{white} dotenvx link bin/mongosh & Generate mongo cli with `.env` setup \tn % Row Count 9 (+ 2) % Row 4 \SetRowColor{LightBackground} dotenvx link bin/redis-cli & Generate redis-cli with `.env` setup \tn % Row Count 11 (+ 2) \hhline{>{\arrayrulecolor{DarkBackground}}--} \SetRowColor{LightBackground} \mymulticolumn{2}{x{8.4cm}}{Environment variables from `.env`: \newline \newline - MYSQL\_URL, POSTGRES\_URL, DATABASE\_URL \newline - MONGODB\_URL \newline - REDIS\_URL} \tn \hhline{>{\arrayrulecolor{DarkBackground}}--} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{8.4cm}{X} \SetRowColor{DarkBackground} \mymulticolumn{1}{x{8.4cm}}{\bf\textcolor{white}{.env file example}} \tn \SetRowColor{LightBackground} \mymulticolumn{1}{x{8.4cm}}{\# -{}-{}- \newline \# uuid: \seqsplit{f7580ac5-0b24-4385-b3ff-819225b687f3} \newline \# name: input your name here \newline \# group: demo \newline \# -{}-{}- \newline \newline DOTENV\_PUBLIC\_KEY="02b497...." \newline \newline \# Environment variables. MAKE SURE to ENCRYPT them before committing to source control \newline HELLO=encrypted:base64\_text} \tn \hhline{>{\arrayrulecolor{DarkBackground}}-} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{8.4cm}{X} \SetRowColor{DarkBackground} \mymulticolumn{1}{x{8.4cm}}{\bf\textcolor{white}{.env.key file example}} \tn \SetRowColor{LightBackground} \mymulticolumn{1}{x{8.4cm}}{\# -{}-{}- \newline \# uuid: \seqsplit{8499c5c3-cee3-4c94-99a4-9c86b2ed5dd9} \newline \# name: input your name here \newline \# group: demo \newline \# -{}-{}- \newline \newline \# Private decryption keys. DO NOT commit to source control \newline DOTENV\_PRIVATE\_KEY=9e7018-hex-text \newline DOTENV\_PRIVATE\_KEY\_EXAMPLE=a3d15-hex-text} \tn \hhline{>{\arrayrulecolor{DarkBackground}}-} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{8.4cm}{X} \SetRowColor{DarkBackground} \mymulticolumn{1}{x{8.4cm}}{\bf\textcolor{white}{GitHub Actions setup}} \tn \SetRowColor{LightBackground} \mymulticolumn{1}{x{8.4cm}}{jobs: \newline dotenvx-demo: \newline runs-on: ubuntu-latest \newline steps: \newline - uses: actions/checkout@v4 \newline - uses: \seqsplit{linux-china/setup-dotenvx@main} \newline - run: npm install \newline - run: \seqsplit{\$HOME/.cargo/bin/dotenvx} run -{}- node index.js \newline env: \newline DOTENV\_PRIVATE\_KEY: \$\{\{ \seqsplit{secrets.DOTENV\_PRIVATE\_KEY} \}\}} \tn \hhline{>{\arrayrulecolor{DarkBackground}}-} \SetRowColor{LightBackground} \mymulticolumn{1}{x{8.4cm}}{Please add `DOTENV\_PRIVATE\_KEY` secret to the `Repository secrets` first. \newline If you use act for local GitHub Actions test, please use `act -j dotenvx-demo -{}-secret-file .env.keys`.} \tn \hhline{>{\arrayrulecolor{DarkBackground}}-} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{8.4cm}{x{3.68 cm} x{4.32 cm} } \SetRowColor{DarkBackground} \mymulticolumn{2}{x{8.4cm}}{\bf\textcolor{white}{Get/Set item from .env file}} \tn % Row 0 \SetRowColor{LightBackground} dotenvx get admin & Get `ADMIN` value from .env file \tn % Row Count 2 (+ 2) % Row 1 \SetRowColor{white} dotenvx get & GET all key/value pairs from .env file \tn % Row Count 4 (+ 2) % Row 2 \SetRowColor{LightBackground} dotenvx set admin Jackie & SET `ADMIN` to `Jackie` in .env file \tn % Row Count 6 (+ 2) % Row 3 \SetRowColor{white} dotenvx set admin - & SET `ADMIN` from input \tn % Row Count 8 (+ 2) % Row 4 \SetRowColor{LightBackground} dotenvx set key - \textless{} ./private.pem & Set `key` from text of private.pem file \tn % Row Count 10 (+ 2) % Row 5 \SetRowColor{white} dotenvx set \textless{}key\textgreater{} -{}-clipboard & Set key from clipboard \tn % Row Count 12 (+ 2) \hhline{>{\arrayrulecolor{DarkBackground}}--} \SetRowColor{LightBackground} \mymulticolumn{2}{x{8.4cm}}{Please press Ctrl+D on Linux/macOS or Ctrl+Z on Windows to finish input.} \tn \hhline{>{\arrayrulecolor{DarkBackground}}--} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{8.4cm}{x{3.36 cm} x{4.64 cm} } \SetRowColor{DarkBackground} \mymulticolumn{2}{x{8.4cm}}{\bf\textcolor{white}{Switch profile}} \tn % Row 0 \SetRowColor{LightBackground} dotenvx -p test & Change profile to test \tn % Row Count 1 (+ 1) % Row 1 \SetRowColor{white} dotenvx encrypt -f .env.test & Change profile to test by .env file name \tn % Row Count 3 (+ 2) % Row 2 \SetRowColor{LightBackground} NODE\_ENV=test dotenvx encrypt & Change profile to test by envrionment \tn % Row Count 5 (+ 2) \hhline{>{\arrayrulecolor{DarkBackground}}--} \SetRowColor{LightBackground} \mymulticolumn{2}{x{8.4cm}}{profile's environment variable names: NODE\_ENV, RUN\_ENV, APP\_ENV, \seqsplit{SPRING\_PROFILES\_ACTIVE.}} \tn \hhline{>{\arrayrulecolor{DarkBackground}}--} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{8.4cm}{x{3.6 cm} x{4.4 cm} } \SetRowColor{DarkBackground} \mymulticolumn{2}{x{8.4cm}}{\bf\textcolor{white}{Run command with .env support}} \tn % Row 0 \SetRowColor{LightBackground} dotenvx run -{}- ./demo.sh & Inject env variables from .env and run ./demo.sh \tn % Row Count 3 (+ 3) % Row 1 \SetRowColor{white} dotenvx -f prod run -{}- ./demo.sh & Inject env variables from .env.prod and run ./demo.sh \tn % Row Count 6 (+ 3) % Row 2 \SetRowColor{LightBackground} dotenvx run -{}- echo '\$HELLO' & Inject env variables from .env to run command line \tn % Row Count 9 (+ 3) % Row 3 \SetRowColor{white} dotenvx -c 'echo \$HELLO' & Inject env variables from .env and run commad line \tn % Row Count 12 (+ 3) \hhline{>{\arrayrulecolor{DarkBackground}}--} \SetRowColor{LightBackground} \mymulticolumn{2}{x{8.4cm}}{Please use single quote to wrap variables from .env file.} \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}{Rotate key pair for project}} \tn % Row 0 \SetRowColor{LightBackground} dotenvx rotate & Rotate key pair for .env file \tn % Row Count 2 (+ 2) % Row 1 \SetRowColor{white} dotenvx -p prod rotate & Rotate key pair for .env.prod file \tn % Row Count 4 (+ 2) % Row 2 \SetRowColor{LightBackground} dotenvx rotate -f .env.prod & Rotate key pair for .env.prod file \tn % Row Count 6 (+ 2) \hhline{>{\arrayrulecolor{DarkBackground}}--} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{8.4cm}{x{2.72 cm} x{5.28 cm} } \SetRowColor{DarkBackground} \mymulticolumn{2}{x{8.4cm}}{\bf\textcolor{white}{Global private key management}} \tn % Row 0 \SetRowColor{LightBackground} dotenvx init -{}-global & Generate global private keys in \$HOME/.env.keys \tn % Row Count 2 (+ 2) % Row 1 \SetRowColor{white} dotenvx -{}-seal & Encrypt \$HOME/.env.keys, \seqsplit{\$HOME/.dotenvx/.env.key.json} with your password \tn % Row Count 5 (+ 3) % Row 2 \SetRowColor{LightBackground} dotenvx -{}-unseal & Decrypt \$HOME/.env.keys.aes, \seqsplit{\$HOME/.dotenvx/.env.keys.json.aes} with password \tn % Row Count 8 (+ 3) \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}{Misc}} \tn % Row 0 \SetRowColor{LightBackground} eval \$(dotenvx decrypt -{}-export) & Export .env items to environment variables \tn % Row Count 3 (+ 3) % Row 1 \SetRowColor{white} eval \$(dotenvx get hello -{}-format shell) & Export HELLO from .env items as environment variable \tn % Row Count 6 (+ 3) % Row 2 \SetRowColor{LightBackground} dotenvx ls & List all .env file from current directory recursively \tn % Row Count 9 (+ 3) % Row 3 \SetRowColor{white} dotenvx -f test ls & List all .env.test file from current directory recursively \tn % Row Count 12 (+ 3) % Row 4 \SetRowColor{LightBackground} dotenvx diff key1,key2 & Disply keys' values between all .env files \tn % Row Count 15 (+ 3) % Row 5 \SetRowColor{white} dotenvx diff key1,key2 -{}-format csv & Disply keys' values between all .env files by csv \tn % Row Count 18 (+ 3) % Row 6 \SetRowColor{LightBackground} dotenvx completion -{}-shell zsh & Output auto-completion script for \seqsplit{bash/zsh/fish/powershell} \tn % Row Count 21 (+ 3) \hhline{>{\arrayrulecolor{DarkBackground}}--} \SetRowColor{LightBackground} \mymulticolumn{2}{x{8.4cm}}{{\bf{Tips}}: if you use direnv, and you can add "eval \$(dotenvx decrypt -{}-export)" to the .envrc file to automatically load .env as the environment variables when you enter the directory.} \tn \hhline{>{\arrayrulecolor{DarkBackground}}--} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{8.4cm}{X} \SetRowColor{DarkBackground} \mymulticolumn{1}{x{8.4cm}}{\bf\textcolor{white}{Node.js(Volat), Bun, Deno with Dotenvx}} \tn \SetRowColor{LightBackground} \mymulticolumn{1}{x{8.4cm}}{\#!/bin/bash \newline \newline \# load .env by dotenvx \newline eval \$( dotenvx decrypt -{}-stdout -{}-format shell ) \newline \# Execute bun command with arguments \newline \$HOME/.bun/bin/bun "\$@" \newline \#\$HOME/.deno/bin/deno "\$@"} \tn \hhline{>{\arrayrulecolor{DarkBackground}}-} \SetRowColor{LightBackground} \mymulticolumn{1}{x{8.4cm}}{Volta Dotenvx edition: \seqsplit{https://github.com/linux-china/volta/releases/tag/v2.0.2-dotenvx20250830} \newline \newline Node.js, Bun/Deno script wrapper with Dotenvx: nodew, bunw, denow. \newline \newline You can create wrapper script for Lua, PHP, Perl with same way.} \tn \hhline{>{\arrayrulecolor{DarkBackground}}-} \end{tabularx} \par\addvspace{1.3em} % That's all folks \end{multicols*} \end{document}