How to Use Goose

Getting started with Goose

In this guide, you will learn how to set up Goose, an open-source AI agent framework for autonomous coding tasks. By the end, you'll be able to execute coding tasks efficiently using Goose.

Step 1: Sign up and set up

1. Visit Goose's website.
2. Click on the "Get Started" button on the homepage.
3. Follow the instructions to clone the Goose repository from GitHub. You can do this by running the command:

git clone https://github.com/block/goose.git

1. Navigate to the cloned directory:

cd goose

1. Install the necessary dependencies by running:

npm install

Step 2: Your first task

1. Open your terminal and start Goose by running:

npm start

1. In the console, you will see a prompt. Type your first command, for example, to create a new file:

create_file("example.txt", "Hello, Goose!")

1. Hit Enter. Goose will autonomously create the file with the specified content in your current directory.

Step 3: Get better results

1. To read a file, use:

read_file("example.txt")

1. For running tests, you can input:

run_tests()

1. Ensure you provide clear commands and specify the parameters correctly. This helps Goose to understand your needs better and execute tasks more accurately.

Pro tip

Use the command history feature by pressing the up arrow key in the terminal to quickly access and modify previous commands without typing them again.

Common mistake to avoid

Avoid using vague commands; be specific about what you want Goose to do. For instance, instead of saying "create file", specify the filename and content to prevent confusion and ensure the task is executed correctly.