From beebddd6fe8ce7ed97af6ff4c56cba2d47ba36f5 Mon Sep 17 00:00:00 2001 From: Karim shoair Date: Sat, 30 Aug 2025 22:42:05 +0300 Subject: [PATCH] docs: add cli overview page --- docs/cli/overview.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 docs/cli/overview.md 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