Get Started
Fiberplane Studio is a local debugging companion designed to help you to build, test, and develop Hono APIs.
-
Set up a Hono project
You can set up a basic Hono project via your terminal:
Terminal window npm create hono@latest -- my-appTerminal window pnpm create hono@latest my-appTerminal window yarn create hono@latest my-appIf you want a project that includes an ORM, a database, and is ready to deploy, we recommend using HONC 🪿:
Terminal window npm create honc-app@latestTerminal window pnpm create honc-app@latestTerminal window yarn create honc-app@latest -
Add the Fiberplane Studio client
Install the Studio client library in your Hono project. The client library will report traces to the local Fiberplane Studio and give you rich application context while you’re developing.
Terminal window npm i @fiberplane/hono-otelTerminal window pnpm add @fiberplane/hono-otelTerminal window yarn add @fiberplane/hono-otelTerminal window bun add @fiberplane/hono-otelAdd the client library to
index.ts
index.ts import { instrument } from "@fiberplane/hono-otel";import { Hono } from "hono";const app = new Hono<{ Bindings: Bindings }>();app.get("/", (c) => {return c.text("Hello Hono!");});export default instrument(app);index.ts import { instrument } from "@fiberplane/hono-otel";import { serve } from "@hono/node-server";import { config } from "dotenv";import { Hono } from "hono";// Load environment variables from .env file// You need this to load the `FPX_ENDPOINT` variable!config();const app = new Hono();app.get("/", (c) => c.text("Hello Hono!"));serve({// This is the important line!// Wrap `app` with `instrument` before servingfetch: instrument(app).fetch,port: 3000,}); -
Launch Fiberplane Studio
In a new terminal window start Fiberplane Studio from your project directory:
Terminal window npx @fiberplane/studioTerminal window pnpm @fiberplane/studioTerminal window yarn @fiberplane/studioTerminal window bunx @fiberplane/studioFinally, start (or restart) your application, and you’re ready to go!
Next steps
Learn about the client library Read more about the client library and how to configure it
Make HTTP requests from Studio Use the Studio as your API client in your local development
Inspect request traces Visualize the entire request-response lifecycle of your API
Generate requests with AI Use language models to generate request data to test your API
Test webhooks Inspect incoming webhooks and forward them to your API using the Studio