Karim shoair commited on
Commit ·
59bc501
1
Parent(s): 0f8d78f
docs: add cli overview page
Browse files- docs/cli/overview.md +30 -0
docs/cli/overview.md
ADDED
|
@@ -0,0 +1,30 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# Command Line Interface
|
| 2 |
+
|
| 3 |
+
Since v0.3, Scrapling includes a powerful command-line interface that provides three main capabilities:
|
| 4 |
+
|
| 5 |
+
1. **Interactive Shell**: An interactive Web Scraping shell based on IPython that provides many shortcuts and useful tools
|
| 6 |
+
2. **Extract Commands**: Scrape websites from the terminal without any programming
|
| 7 |
+
3. **Utility Commands**: Installation and management tools
|
| 8 |
+
|
| 9 |
+
```bash
|
| 10 |
+
# Launch interactive shell
|
| 11 |
+
scrapling shell
|
| 12 |
+
|
| 13 |
+
# Convert the content of a page to markdown and save it to a file
|
| 14 |
+
scrapling extract get "https://example.com" content.md
|
| 15 |
+
|
| 16 |
+
# Get help for any command
|
| 17 |
+
scrapling --help
|
| 18 |
+
scrapling extract --help
|
| 19 |
+
```
|
| 20 |
+
|
| 21 |
+
## Requirements
|
| 22 |
+
This section requires you to install the extra `shell` dependency group, like the following:
|
| 23 |
+
```bash
|
| 24 |
+
pip install "scrapling[shell]"
|
| 25 |
+
```
|
| 26 |
+
and the installation of the fetchers' dependencies with the following command
|
| 27 |
+
```bash
|
| 28 |
+
scrapling install
|
| 29 |
+
```
|
| 30 |
+
This downloads all browsers with their system dependencies and fingerprint manipulation dependencies.
|