Skip to content

🕷️ The BEST Web Scraping framework that handles everything from a single request to a full-scale crawl! Don't be shy, join here: https://discord.gg/EMgGbDceNQ and follow here for daily tips and tricks: https://x.com/Scrapling_dev

docs: add cli overview page

Karim shoairbeebddd6fe8c
diff --git a/docs/cli/overview.md b/docs/cli/overview.md
new file mode 100644
index 0000000..5b5d498
--- /dev/null
+++ b/docs/cli/overview.md
@@ -0,0 +1,30 @@
+# Command Line Interface
+
+Since v0.3, Scrapling includes a powerful command-line interface that provides three main capabilities:
+
+1. **Interactive Shell**: An interactive Web Scraping shell based on IPython that provides many shortcuts and useful tools
+2. **Extract Commands**: Scrape websites from the terminal without any programming
+3. **Utility Commands**: Installation and management tools
+
+```bash
+# Launch interactive shell
+scrapling shell
+
+# Convert the content of a page to markdown and save it to a file
+scrapling extract get "https://example.com" content.md
+
+# Get help for any command
+scrapling --help
+scrapling extract --help
+```
+
+## Requirements
+This section requires you to install the extra `shell` dependency group, like the following:
+```bash
+pip install "scrapling[shell]"
+```
+and the installation of the fetchers' dependencies with the following command
+```bash
+scrapling install
+```
+This downloads all browsers with their system dependencies and fingerprint manipulation dependencies.
\ No newline at end of file