FRIENDLY(1)

💖 FRIENDLY(1) 💖

okay bestie, welcome to the friendly manual page ✨ (that's the title, and the manual name is just... friendly, cute right? one whole word, no notes 💅)

---

🌸 NAME 🌸

friendly — friendlier Python tracebacks 🫶

like, tracebacks but they actually talk to you instead of screaming at you in cryptic

---

✨ SYNOPSIS ✨

friendly [OPTIONS] [source] [args ...]

that's the whole vibe. options, maybe a script, maybe some args, go off 👑

---

🦋 DESCRIPTION 🦋

okay so here's the tea: friendly makes Python tracebacks easier to understand by providing

clearer, friendlier error messages in various human languages. 🌈

If no source is provided, Friendly starts an interactive console similar to a Python shell, except with enhanced traceback explanations ✨ (yes, it explains why your code is being like that 😭).

If a script is provided, Friendly runs it as if it were the main module and shows you detailed traceback information if an exception occurs. it's giving "your code broke but make it educational" 💖

---

🎀 POSITIONAL ARGUMENTS 🎀

• source — the path to a Python script to run (like, for example, path/to/script.py). this script gets treated as the main module, as in __name__ == "__main__". periodt 💅
• args — optional arguments you wanna pass along to the script that's chilling in source. yup, it forwards them 🌸

---

👑 OPTIONS 👑

• -h, --help — shows this help message and then dips out. exit stage left 🚪✨
• --lang LANG — sets the interface language for Friendly using a two-letter code, like fr for French or en for English.

⚠️ Note, bestie: translations for French (fr), Russian (ru), and Spanish (es) are currently incomplete. It is recommended to use your default language, English (en). 💀 no cap.

• --version — shows the current version of Friendly and Friendly-Traceback, then exits. two for one 🫶
• -f, --formatter FORMATTER — picks your output formatter. available options include dark and light. choose your aesthetic 🌙☀️
• --background COLOR — sets the background color for the dark or light formatter. must be a hex color code like #ffffff. 🎨
• --debug — enables debug mode (this one's for the developers 👩‍💻).
• --no_debug — disables debug mode. bye bye debug 🤫
• --include CONTENT — says which content to include by default in the traceback. it defaults to friendly_tb when showing the console, and explain otherwise. iykyk 💅
• --python_prompt — uses the standard Python prompt in the interactive console instead of the custom Friendly one. classic era 🐍
• -i — launches the Friendly console after executing the script. main character energy fr fr 👑
• -x — only launches the Friendly console after executing the script if an exception was raised. conditional queen 💅

---

🌈 EXAMPLES 🌈

Display version info:

friendly --version Friendly version 0.7.21

Friendly allows

friendly my_script.py

Run a script and enter the console only if an exception is raised:

friendly -x my_script.py

Run the friendly console in interactive mode:

friendly or friendly -i my_script.py

Use the dark formatter with a custom RGB background color:

friendly -f dark --background "#808080" my_script.py
friendly -f dark --background "#000000" my_script.py
friendly -f dark --background "#505050" my_script.py

Use the light formatter with a custom RGB background color:

friendly -f light --background "#e0f7fa" my_script.py
friendly -f light --background "#fff8b0" my_script.py
friendly -f light --background  "#ccffcc" my_script.py

Friendly allows Combines the parameters

friendly -f dark --background "#2e2e2e" -x my_script.py

friendly -f light --background "#ffffff" -x my_script.py

Changes the console prompt to the default Python prompt (>>>) instead of the custom Friendly prompt:

friendly --python_prompt -i my_script.py

Enables/disables additional information for developers:

friendly --debug my_script.py or friendly --no_debug my_script.py

---

💜 SEE ALSO 💜

see: https://friendly-traceback.github.io/docs/index.html 🦋 go read it, it's iconic

---

🧚 AUTHOR 🧚

Friendly was created by André Roberge. 💖

This manual page was written for the Debian project by Josenilson Ferreira da Silva <nilsonfsilva@hotmail.com>. 🫶

---

and that's the whole page, bestie!! ✨ this is version 0.7.21, dated Sep 2025, and the source is the FRIENDLY(1) man page for the User Commands section — tysm for reading, mwah 💋🎀🌸