firecrawl-hello-world
Create a minimal working FireCrawl example.Use when starting a new FireCrawl integration, testing your setup,or learning basic FireCrawl API patterns.Trigger with phrases like "firecrawl hello world", "firecrawl example","firecrawl quick start", "simple firecrawl code".
When & Why to Use This Skill
The FireCrawl Hello World skill is a developer-focused utility designed to accelerate the initial integration of FireCrawl's web crawling and scraping capabilities. It automates the generation of minimal, functional boilerplate code in both TypeScript and Python, enabling users to quickly verify API credentials and environment configurations. By providing a 'ready-to-run' foundation, it minimizes setup friction and ensures a smooth transition from installation to active development.
Use Cases
- New Project Initialization: Quickly generate the essential boilerplate code required to start a new FireCrawl integration without manual documentation lookups.
- Environment & Auth Verification: Test and confirm that API keys and environment variables are correctly configured in a local or production environment.
- Developer Onboarding: Provide a simple, executable reference for team members to learn the basic syntax and client initialization patterns of the FireCrawl SDK.
- Troubleshooting & Diagnostics: Use as a 'known-good' script to isolate and diagnose connection issues, rate limiting, or network configuration problems.
| name | firecrawl-hello-world |
|---|---|
| description | | |
| allowed-tools | Read, Write, Edit |
| version | 1.0.0 |
| license | MIT |
| author | Jeremy Longshore <jeremy@intentsolutions.io> |
FireCrawl Hello World
Overview
Minimal working example demonstrating core FireCrawl functionality.
Prerequisites
- Completed
firecrawl-install-authsetup - Valid API credentials configured
- Development environment ready
Instructions
Step 1: Create Entry File
Create a new file for your hello world example.
Step 2: Import and Initialize Client
import { FireCrawlClient } from '@firecrawl/sdk';
const client = new FireCrawlClient({
apiKey: process.env.FIRECRAWL_API_KEY,
});
Step 3: Make Your First API Call
async function main() {
// Your first API call here
}
main().catch(console.error);
Output
- Working code file with FireCrawl client initialization
- Successful API response confirming connection
- Console output showing:
Success! Your FireCrawl connection is working.
Error Handling
| Error | Cause | Solution |
|---|---|---|
| Import Error | SDK not installed | Verify with npm list or pip show |
| Auth Error | Invalid credentials | Check environment variable is set |
| Timeout | Network issues | Increase timeout or check connectivity |
| Rate Limit | Too many requests | Wait and retry with exponential backoff |
Examples
TypeScript Example
import { FireCrawlClient } from '@firecrawl/sdk';
const client = new FireCrawlClient({
apiKey: process.env.FIRECRAWL_API_KEY,
});
async function main() {
// Your first API call here
}
main().catch(console.error);
Python Example
from firecrawl import FireCrawlClient
client = FireCrawlClient()
# Your first API call here
Resources
Next Steps
Proceed to firecrawl-local-dev-loop for development workflow setup.