Getting Started
Swordfish is a browser extension that gives you an AI coding partner right in your browser. It can read your code, interact with web pages, and help you build, debug, and ship software faster.
Installation
-
Install the Browser Extension
The extension provides the chat interface and browser observation capabilities. Install it from the Chrome Web Store (link coming soon).
-
Install the CLI Tool
The CLI server enables file system access and command execution. Install it globally:
npm install -g swordfish-agentThen navigate to your project directory and run:
swordfishThis starts the CLI server on port 8765.
-
Start a Conversation
Open the Swordfish extension in your browser. Click "New" to start a fresh conversation. The agent will automatically connect to the active tab.
Your First Task
Try asking Swordfish to do something simple first:
- "Take a screenshot of this page"
- "What's the current URL?"
- "Read the README.md file"
Once you're comfortable, you can move on to more complex tasks like:
- "Add commenting functionality, test it, and fix any bugs"
- "We've got a bunch of console log errors, resolve them"
- "The data we are displaying looks odd, can you check the api response"
Swordfish works best when you give it context. Use the Pre-reads feature to automatically include important project files in every conversation.
Next Steps
- Understanding Conversations - Learn how chats work, when to start new ones, and how to reconnect to tabs
- Including Events in Chat - How to include console logs and network requests in your conversations
- Swordfish CLI - More details about the CLI server and file operations