{"id":28096468,"url":"https://github.com/marco-souza/rest.nvim","last_synced_at":"2026-05-16T19:05:55.758Z","repository":{"id":292225946,"uuid":"980092573","full_name":"marco-souza/rest.nvim","owner":"marco-souza","description":"Postman-like nvim client","archived":false,"fork":false,"pushed_at":"2025-11-17T21:45:39.000Z","size":51,"stargazers_count":8,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-11-17T22:23:06.294Z","etag":null,"topics":["api","lua","nvim","plenary","postman","postman-collection","rest-client"],"latest_commit_sha":null,"homepage":"https://github.com/marco-souza/rest.nvim","language":"Lua","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/marco-souza.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-05-08T14:49:52.000Z","updated_at":"2025-11-17T21:45:43.000Z","dependencies_parsed_at":"2025-05-08T19:44:02.427Z","dependency_job_id":"b71e119c-e12d-4d53-9da2-dbbebcfa8f01","html_url":"https://github.com/marco-souza/rest.nvim","commit_stats":null,"previous_names":["marco-souza/rest.nvim"],"tags_count":2,"template":false,"template_full_name":"marco-souza/plugin.nvim","purl":"pkg:github/marco-souza/rest.nvim","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marco-souza%2Frest.nvim","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marco-souza%2Frest.nvim/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marco-souza%2Frest.nvim/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marco-souza%2Frest.nvim/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/marco-souza","download_url":"https://codeload.github.com/marco-souza/rest.nvim/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marco-souza%2Frest.nvim/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33115437,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-16T18:38:32.183Z","status":"ssl_error","status_checked_at":"2026-05-16T18:38:29.903Z","response_time":115,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","lua","nvim","plenary","postman","postman-collection","rest-client"],"created_at":"2025-05-13T16:21:35.078Z","updated_at":"2026-05-16T19:05:55.753Z","avatar_url":"https://github.com/marco-souza.png","language":"Lua","funding_links":["https://www.buymeacoffee.com/marco-souza"],"categories":[],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003erest.nvim\u003c/h1\u003e\n\n\u003cdiv\u003e\n  \u003ch4 align=\"center\"\u003e\n    \u003ca href=\"#dependencies\"\u003eDependencies\u003c/a\u003e ·\n    \u003ca href=\"#installation\"\u003eInstallation\u003c/a\u003e ·\n    \u003ca href=\"#usage\"\u003eUsage\u003c/a\u003e ·\n    \u003ca href=\"docs/\"\u003eDocumentation\u003c/a\u003e ·\n    \u003ca href=\"docs/FEATURES.md\"\u003eFeatures\u003c/a\u003e\n  \u003c/h4\u003e\n\u003c/div\u003e\n\n\u003cdiv align=\"center\"\u003e\n  \u003ca href=\"https://github.com/marco-souza/rest.nvim/releases/latest\"\n    \u003e\u003cimg\n      alt=\"Latest release\"\n      src=\"https://img.shields.io/github/v/release/marco-souza/rest.nvim?style=for-the-badge\u0026logo=starship\u0026logoColor=D9E0EE\u0026labelColor=302D41\u0026\u0026color=d9b3ff\u0026include_prerelease\u0026sort=semver\"\n  /\u003e\u003c/a\u003e\n  \u003ca href=\"https://github.com/marco-souza/rest.nvim/pulse\"\n    \u003e\u003cimg\n      alt=\"Last commit\"\n      src=\"https://img.shields.io/github/last-commit/marco-souza/rest.nvim?style=for-the-badge\u0026logo=github\u0026logoColor=D9E0EE\u0026labelColor=302D41\u0026color=9fdf9f\"\n  /\u003e\u003c/a\u003e\n  \u003ca href=\"https://github.com/neovim/neovim/releases/latest\"\n    \u003e\u003cimg\n      alt=\"Latest Neovim\"\n      src=\"https://img.shields.io/github/v/release/neovim/neovim?style=for-the-badge\u0026logo=neovim\u0026logoColor=D9E0EE\u0026label=Neovim\u0026labelColor=302D41\u0026color=99d6ff\u0026sort=semver\"\n  /\u003e\u003c/a\u003e\n  \u003ca href=\"http://www.lua.org/\"\n    \u003e\u003cimg\n      alt=\"Made with Lua\"\n      src=\"https://img.shields.io/badge/Built%20with%20Lua-grey?style=for-the-badge\u0026logo=lua\u0026logoColor=D9E0EE\u0026label=Lua\u0026labelColor=302D41\u0026color=b3b3ff\"\n  /\u003e\u003c/a\u003e\n  \u003c!-- \u003ca href=\"https://www.buymeacoffee.com/marco-souza\" --\u003e\n  \u003c!--   \u003e\u003cimg --\u003e\n  \u003c!--     alt=\"Buy me a coffee\" --\u003e\n  \u003c!--     src=\"https://img.shields.io/badge/Buy%20me%20a%20coffee-grey?style=for-the-badge\u0026logo=buymeacoffee\u0026logoColor=D9E0EE\u0026label=Sponsor\u0026labelColor=302D41\u0026color=ffff99\" --\u003e\n  \u003c!-- /\u003e\u003c/a\u003e --\u003e\n\u003c/div\u003e\n\u003chr /\u003e\n\nA Neovim plugin that provides a REST client interface for making HTTP requests directly from your editor. Ideal for API testing and development workflows.\n\n### Features\n\n- **Postman-like Dashboard**: Dual-pane layout with request editor (30%) and response viewer (70%)\n- **Async HTTP Requests**: Non-blocking async execution with animated loading spinner\n- **Direct Command Execution**: `:Rest GET https://api.example.com` for instant requests\n- **Interactive Dashboard**: `:Rest` to open the request/response editor\n- **Support for `.rest` files**: Define and execute API requests from `.rest` files\n- **Full HTTP Method Support**: GET, POST, PUT, DELETE, PATCH, OPTIONS, HEAD\n- **Request Customization**: Edit headers, body, and URL in real-time\n- **Layout Toggle**: Switch between horizontal and vertical layouts with `r` key\n- **Response Formatting**: Automatic JSON pretty-printing and detection\n- **Environment Variables**: Use `$VAR_NAME` syntax in requests\n- **Syntax Highlighting**: Treesitter-powered highlighting for request and response\n- **Word Wrap Toggle**: Easy toggling of line wrapping with `\u003cC-w\u003e`\n- **Auto-load REST Files**: Automatically loads content from open `.rest` files\n- **Seamless Integration**: Built with `nui.nvim` and `plenary.nvim`\n\n## Dependencies\n\n- [nui.nvim](https://github.com/MunifTanjim/nui.nvim) - UI components\n- [plenary.nvim](https://github.com/nvim-lua/plenary.nvim) - Lua utilities and HTTP client\n\n## Installation\n\nInstall with your preferred package manager:\n\n### Using lazy.nvim\n\n```lua\n{\n  \"marco-souza/rest.nvim\",\n  dependencies = {\n    \"MunifTanjim/nui.nvim\",\n    \"nvim-lua/plenary.nvim\"\n  },\n  config = function()\n    require(\"rest\").setup()\n  end,\n}\n```\n\n### Configuration\n\nCustomize the dashboard with options:\n\n```lua\nrequire(\"rest\").setup({\n  request_size = \"30%\",    -- Request pane size\n  response_size = \"70%\",   -- Response pane size\n  width = \"80%\",           -- Dashboard width\n  height = \"80%\",          -- Dashboard height\n  border = \"rounded\",      -- Border style\n  margin = 0,              -- Margin around dashboard\n})\n```\n\nFor detailed configuration options, see the `DashboardOptions` type in `lua/rest/types.lua`.\n\n## Usage\n\n### Commands\n\nThe plugin provides the following commands:\n\n- `:Rest` - Opens/toggles the REST client dashboard\n- `:Rest GET https://api.example.com` - Execute GET request directly and show result\n- `:Rest POST https://api.example.com` - Execute POST request (edit body in dashboard)\n- `:Rest \u003cMETHOD\u003e \u003cURL\u003e` - Execute any HTTP request directly\n\n### Working with REST files\n\nYou can create `.rest` files to define your API requests. When you open the REST dashboard with a `.rest` file active, its content will be loaded into the dashboard.\n\nExample REST file format:\n\n```\nGET https://api.example.com/users\n\n# Headers\nContent-Type: application/json\nAuthorization: Bearer your-token-here\n\n# Body\n{\"query\": \"example\"}\n```\n\n### Dashboard Usage\n\nOnce you have the dashboard open:\n\n1. **Edit Request** (Left Pane - 30%):\n   - Edit method, URL, headers, and body\n   - Format: `METHOD URL` on first line\n   - Headers: `Key: Value` format, one per line\n   - Body: Everything after headers\n\n2. **View Response** (Right Pane - 70%):\n   - Press `\u003cC-s\u003e` to execute the request\n   - Watch the animated spinner while loading\n   - Response appears with status, headers, and body\n   - JSON automatically formatted and pretty-printed\n\n3. **Keyboard Shortcuts**:\n    - `\u003cC-s\u003e` - Execute request\n    - `\u003cC-w\u003e` - Toggle word wrap in response\n    - `\u003cC-y\u003e` - Copy response to clipboard\n    - `r` - Toggle between horizontal and vertical layout\n    - `q` - Close the dashboard\n\n### REST File Format\n\n- First line: `METHOD URL` (e.g., `GET https://api.example.com`)\n- Headers: `Key: Value` format, one per line\n- Body: Everything after headers (JSON format supported)\n- Comments: Lines starting with `#` are treated as comments\n\n### Supported HTTP Methods\n\n- GET\n- POST\n- PUT\n- DELETE\n- PATCH\n- OPTIONS\n- HEAD\n\n## Documentation\n\nComprehensive documentation is available in the `docs/` folder:\n\n- **[Features](docs/FEATURES.md)** - Complete feature overview and roadmap\n- **[Architecture](docs/ARCHITECTURE.md)** - Technical design and module structure\n- **[Development](docs/DEVELOPMENT.md)** - Development guide for contributors\n- **[Migration](docs/MIGRATION.md)** - Upgrade guide from previous versions\n\nStart with [Documentation Index](docs/README.md) for a complete overview.\n\n## License\n\nMIT License. See [LICENSE](LICENSE) for details.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmarco-souza%2Frest.nvim","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmarco-souza%2Frest.nvim","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmarco-souza%2Frest.nvim/lists"}