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

  1. Install the Browser Extension

    The extension provides the chat interface and browser observation capabilities. Install it from the Chrome Web Store (link coming soon).

  2. Install the CLI Tool

    The CLI server enables file system access and command execution. Install it globally:

    npm install -g swordfish-agent

    Then navigate to your project directory and run:

    swordfish

    This starts the CLI server on port 8765.

  3. 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"
Example: Tool Call in Action
browser_get_current_url
Click the tool call header to expand and see the arguments and result. The green border and checkmark indicate a successful execution.

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"
💡 Tip

Swordfish works best when you give it context. Use the Pre-reads feature to automatically include important project files in every conversation.

Next Steps