Skip to content

Commit e21e4e5

Browse files
committed
Use AutoSDK CLI for docs sync
1 parent c595a5c commit e21e4e5

5 files changed

Lines changed: 38 additions & 396 deletions

File tree

.github/workflows/mkdocs.yml

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ on:
77
- 'docs/**'
88
- 'mkdocs.yml'
99
- 'examples/**'
10-
- 'src/helpers/GenerateDocs/**'
10+
- 'autosdk.docs.json'
1111
- '.github/workflows/mkdocs.yml'
1212

1313
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
@@ -37,8 +37,11 @@ jobs:
3737
with:
3838
dotnet-version: 10.0.x
3939

40+
- name: Install AutoSDK CLI
41+
run: dotnet tool install --global autosdk.cli --prerelease
42+
4043
- name: Generate docs
41-
run: dotnet run --project src/helpers/GenerateDocs/GenerateDocs.csproj .
44+
run: autosdk docs sync .
4245

4346
- name: Build with MkDocs
4447
run: |
@@ -59,4 +62,4 @@ jobs:
5962
steps:
6063
- name: Deploy to GitHub Pages
6164
id: deployment
62-
uses: actions/deploy-pages@v4
65+
uses: actions/deploy-pages@v4

Firecrawl.slnx

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
<Solution>
22
<Folder Name="/helpers/">
3-
<Project Path="src/helpers/GenerateDocs/GenerateDocs.csproj" />
43
<Project Path="src/helpers/TrimmingHelper/TrimmingHelper.csproj" />
54
</Folder>
65
<Folder Name="/libs/">

docs/index.md

Lines changed: 32 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -45,11 +45,40 @@ foreach (var data in jobResponse.Data)
4545
### CLI
4646
```bash
4747
dotnet tool install -g Firecrawl.Cli
48-
firecrawl auth <API_KEY>
49-
firecrawl scrape https://docs.firecrawl.dev/features/scrape // saves it to output.md
50-
firecrawl crawl https://docs.firecrawl.dev/ --limit 5 // saves all .md files to docs.firecrawl.dev folder
48+
firecrawl auth set <API_KEY>
49+
firecrawl scrape https://docs.firecrawl.dev/features/scrape --format markdown
50+
firecrawl crawl start https://docs.firecrawl.dev/ --limit 5 --wait
51+
firecrawl team credit-usage --json
5152
```
5253

54+
Auth precedence:
55+
1. `--api-key`
56+
2. `FIRECRAWL_API_KEY`
57+
3. `~/.firecrawl/apiKey.txt` from `firecrawl auth set`
58+
59+
Base URL precedence:
60+
1. `--base-url`
61+
2. `FIRECRAWL_BASE_URL`
62+
3. SDK default
63+
64+
Universal CLI behavior:
65+
- `--json` is available on every command for deterministic machine-readable output.
66+
- Async start commands support `--wait`, `--poll-interval`, and `--wait-timeout`.
67+
- `--input <file|->` loads a JSON request body, and explicit flags override matching fields.
68+
- `crawl status` and `batch-scrape status` support `--output-dir` to write one file set per returned page.
69+
70+
Command tree:
71+
- `auth set|clear|status`
72+
- `scrape <url>`
73+
- `batch-scrape start|status|cancel|errors`
74+
- `crawl start|status|cancel|errors|active`
75+
- `map <url>`
76+
- `extract start|status`
77+
- `deep-research start|status`
78+
- `team credit-usage|token-usage`
79+
- `search <query>`
80+
- `llmstxt generate|status`
81+
5382
## Support
5483

5584
Priority place for bugs: https://github.com/tryAGI/Firecrawl/issues

src/helpers/GenerateDocs/GenerateDocs.csproj

Lines changed: 0 additions & 9 deletions
This file was deleted.

0 commit comments

Comments
 (0)