Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions website/.gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,9 @@
/.next/
/out/

# fumadocs
.source/

# production
/build

Expand All @@ -40,5 +43,5 @@ yarn-error.log*
*.tsbuildinfo
next-env.d.ts

# synced docs (generated by scripts/sync-docs.ts)
/content
# generated files
content/changelog.mdx
2 changes: 2 additions & 0 deletions website/.prettierignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# Ignore artifacts:
build
coverage
.source
content/changelog.mdx
31 changes: 16 additions & 15 deletions website/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,15 +17,13 @@

## About

This is the source code for **[reqsh.dev](https://reqsh.dev)** which serves the homepage, docs, changelog and roadmap for [reqsh](https://github.com/hars-21/reqsh).

The main reqsh project lives at **[github.com/hars-21/reqsh](https://github.com/hars-21/reqsh)**.
This directory contains **[reqsh.dev](https://reqsh.dev)**, the landing page and documentation site for reqsh. It lives inside the main reqsh repository so the website and product documentation change together.

## Tech Stack

- [Next.js](https://nextjs.org) 16 (App Router)
- [Fumadocs](https://fumadocs.dev) for documentation
- [Tailwind CSS](https://tailwindcss.com) v4
- [shadcn/ui](https://ui.shadcn.com)
- [TypeScript](https://www.typescriptlang.org)

## Getting Started
Expand All @@ -35,28 +33,31 @@ pnpm install
pnpm dev
```

The docs are synced from the main repo on build:
The site compiles documentation from `content/docs/`. The changelog is copied from the repository
root before development and production builds:

```sh
pnpm build # runs sync-docs then next build
pnpm sync:changelog
pnpm build
```

## Project Structure

```
src/
app/
page.tsx # Homepage
docs/ # Documentation pages
changelog/ # Changelog
roadmap/ # Roadmap
page.tsx # Landing page
changelog/ # Generated changelog page
docs/ # Fumadocs routes and layout
install.sh/ # Install script proxy
changelog.xml/ # RSS feed
components/ # UI components
lib/ # Doc parsing and utilities
components/ # Shared site and MDX components
lib/source.ts # Fumadocs sources for repository content
content/
docs/ # Product documentation
changelog.mdx # Generated from ../CHANGELOG.md
scripts/
sync-docs.ts # Pulls docs from GitHub
content/docs/ # Auto-generated (gitignored)
sync-changelog.mjs # Generates the changelog content
../src/ # Rust CLI source
```

## License
Expand Down
25 changes: 0 additions & 25 deletions website/components.json

This file was deleted.

22 changes: 10 additions & 12 deletions docs/commands.md → website/content/docs/commands.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@ description: Full reference for all REPL commands available in reqsh.
order: 4
---

# Commands

Beyond standard HTTP methods (`GET`, `POST`, `PUT`, `PATCH`, `DELETE`, `HEAD`, `OPTIONS`), reqsh provides specific REPL commands to manage your session.

## Request Syntax
Expand Down Expand Up @@ -65,16 +63,16 @@ HTTP methods are case-insensitive. You can also use absolute URLs without settin

`request` is an alias for `req`.

| Command | Usage | Description |
| ------------ | ------------------------ | ------------------------------- |
| `req save` | `req save <name>` | Save the last executed request. |
| `req run` | `req run <name>` | Execute a saved request. |
| `req rerun` | `req rerun` | Re-run the last executed request. |
| `req list` | `req list` | List all saved requests. |
| `req show` | `req show <name>` | Show a saved request. |
| `req rename` | `req rename <old> <new>` | Rename a saved request. |
| `req remove` | `req remove <name>` | Delete a saved request by name. |
| `req clear` | `req clear` | Delete all saved requests. |
| Command | Usage | Description |
| ------------------- | -------------------------- | -------------------------------------- |
| `req save` | `req save <name>` | Save the last executed request. |
| `req run` | `req run <name>` | Execute a saved request. |
| `req rerun` | `req rerun` | Re-run the last executed request. |
| `req list` | `req list` | List all saved requests. |
| `req show` | `req show <name>` | Show a saved request. |
| `req rename` | `req rename <old> <new>` | Rename a saved request. |
| `req remove` | `req remove <name>` | Delete a saved request by name. |
| `req clear` | `req clear` | Delete all saved requests. |
| `req save-response` | `req save-response <path>` | Save the last response body to a file. |

### History
Expand Down
2 changes: 0 additions & 2 deletions docs/introduction.md → website/content/docs/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@ description: Master the interactive HTTP shell - install, configure and execute
order: 1
---

# Introduction

Master the interactive HTTP shell. Learn how to install, configure your environment and execute requests efficiently.

## Getting Started
Expand Down
4 changes: 1 addition & 3 deletions docs/install.md → website/content/docs/install.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@ description: Install reqsh via Homebrew, Cargo, script, prebuilt binary or build
order: 2
---

# Installation

Get reqsh running on your system in seconds. Choose the method that best fits your workflow.

## Homebrew
Expand All @@ -32,7 +30,7 @@ cargo install reqsh
The fastest and recommended way to install. This script detects your OS and architecture, downloads the latest binary and places it in your PATH.

```sh
curl -fsSL https://reqsh.dev/install.sh | sh
curl -fsSL https://github.com/hars-21/reqsh/releases/latest/download/reqsh-installer.sh | sh
```

## Prebuilt Binary
Expand Down
4 changes: 4 additions & 0 deletions website/content/docs/meta.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"title": "Documentation",
"pages": ["index", "install", "usage", "commands", "variables", "migration"]
}
4 changes: 1 addition & 3 deletions docs/migration.md → website/content/docs/migration.mdx
Original file line number Diff line number Diff line change
@@ -1,11 +1,9 @@
---
title: Migration Guide
title: Migrating to v0.3.0
description: Breaking changes in v0.3.0 and how to migrate from earlier versions.
order: 6
---

# Migrating to v0.3.0

v0.3.0 is a major refactor of reqsh's internals (new lexer, parser and AST, split executor, reworked session management) and introduces several **breaking command changes**. The old `header <key> <value>`, `unset`, `vars`, `headers` and bare `save`/`run`/`requests` commands no longer exist, every session command now has an explicit, scoped form.

## Command Changes
Expand Down
2 changes: 0 additions & 2 deletions docs/usage.md → website/content/docs/usage.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@ description: Learn how to use reqsh for API testing workflows in the interactive
order: 3
---

# Usage

Learn how to use reqsh effectively for your API testing workflow.

## Starting a Session
Expand Down
2 changes: 0 additions & 2 deletions docs/variables.md → website/content/docs/variables.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@ description: Store and interpolate variables in requests using {{name}} syntax.
order: 5
---

# Variables

Variables let you store reusable values and interpolate them into requests using `{{name}}` syntax.

## Setting Variables
Expand Down
5 changes: 4 additions & 1 deletion website/next.config.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import { createMDX } from 'fumadocs-mdx/next';
import type { NextConfig } from 'next';

const nextConfig: NextConfig = {
Expand All @@ -6,4 +7,6 @@ const nextConfig: NextConfig = {
},
};

export default nextConfig;
const withMDX = createMDX();

export default withMDX(nextConfig);
22 changes: 9 additions & 13 deletions website/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,32 +3,29 @@
"version": "0.1.0",
"private": true,
"scripts": {
"sync:changelog": "node scripts/sync-changelog.mjs",
"predev": "pnpm sync:changelog",
"dev": "next dev",
"prebuild": "tsx scripts/sync-docs.ts",
"prebuild": "pnpm sync:changelog",
"build": "next build",
"start": "next start",
"lint": "eslint",
"format": "prettier --write ."
},
"dependencies": {
"@base-ui/react": "^1.6.0",
"@types/mdx": "^2.0.14",
"@vercel/analytics": "^2.0.1",
"@vercel/speed-insights": "^2.0.0",
"class-variance-authority": "^0.7.1",
"clsx": "^2.1.1",
"fumadocs-core": "^16.15.14",
"fumadocs-mdx": "^15.4.5",
"fumadocs-ui": "^16.15.14",
"lucide-react": "^1.14.0",
"motion": "^12.42.2",
"motion": "^13.4.4",
"next": "16.2.4",
"next-themes": "^0.4.6",
"posthog-js": "^1.418.10",
"react": "19.2.4",
"react-dom": "19.2.4",
"react-markdown": "^10.1.0",
"rehype-highlight": "^7.0.2",
"remark-gfm": "^4.0.1",
"shadcn": "^4.13.0",
"tailwind-merge": "^3.6.0",
"tw-animate-css": "^1.4.0"
"react-dom": "19.2.4"
},
"devDependencies": {
"@tailwindcss/postcss": "^4",
Expand All @@ -39,7 +36,6 @@
"eslint-config-next": "16.2.4",
"prettier": "3.8.3",
"tailwindcss": "^4",
"tsx": "^4.23.1",
"typescript": "^5"
}
}
Loading