{"id":13564109,"url":"https://github.com/Escape-Technologies/graphman","last_synced_at":"2025-04-03T21:30:24.247Z","repository":{"id":43230015,"uuid":"511153960","full_name":"Escape-Technologies/graphman","owner":"Escape-Technologies","description":"Quikly scaffold a postman collection for a GraphQL API. Compatible with Postman \u0026 Insomnia.","archived":false,"fork":false,"pushed_at":"2023-02-09T21:18:53.000Z","size":198,"stargazers_count":236,"open_issues_count":7,"forks_count":12,"subscribers_count":7,"default_branch":"main","last_synced_at":"2024-04-22T12:07:04.826Z","etag":null,"topics":["api","deno","escape","graphql","graphql-tools","insomnia","postman","typescript"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","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/Escape-Technologies.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2022-07-06T13:43:41.000Z","updated_at":"2024-03-14T03:42:38.000Z","dependencies_parsed_at":"2024-01-09T15:01:40.742Z","dependency_job_id":"5e914001-4483-4e64-b047-941309e4d9a0","html_url":"https://github.com/Escape-Technologies/graphman","commit_stats":{"total_commits":68,"total_committers":7,"mean_commits":9.714285714285714,"dds":0.5,"last_synced_commit":"ce3cd079967c6974e26df6c454c317151242e6a9"},"previous_names":[],"tags_count":11,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Escape-Technologies%2Fgraphman","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Escape-Technologies%2Fgraphman/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Escape-Technologies%2Fgraphman/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Escape-Technologies%2Fgraphman/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Escape-Technologies","download_url":"https://codeload.github.com/Escape-Technologies/graphman/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246847137,"owners_count":20843444,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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","deno","escape","graphql","graphql-tools","insomnia","postman","typescript"],"created_at":"2024-08-01T13:01:26.636Z","updated_at":"2025-04-03T21:30:24.226Z","avatar_url":"https://github.com/Escape-Technologies.png","language":"TypeScript","readme":"# GraphMan\n\n\u003cp align=\"center\"\u003e\n  \u003cimg width=\"300\" src=\"https://raw.githubusercontent.com/Escape-Technologies/graphman/main/graphman.svg\"\u003e\n  \u003cbr\u003e\n  Quickly scaffold a postman collection for a GraphQL API.\n\u003c/p\u003e\n\n---\n\nGraphMan CLI generates an complete collection from a GraphQL endpoint,\ncontaining one request per query \u0026 mutation, with pre filled fields, parameters\nand variables.\n\n_Note: GraphMan is designed for the postman-collection spec 2.1_\n\n✨GraphMan is fully compatible with the Insomnia API Client out of the box!✨\n\n### Status\n\n![Version](https://img.shields.io/github/v/release/Escape-Technologies/graphman)\n[![CD](https://github.com/Escape-Technologies/graphman/actions/workflows/cd.yaml/badge.svg)](https://github.com/Escape-Technologies/graphman/actions/workflows/cd.yaml)\n[![Checks](https://github.com/Escape-Technologies/graphman/actions/workflows/check.yml/badge.svg)](https://github.com/Escape-Technologies/graphman/actions/workflows/check.yml)\n\n## Motivation\n\nVisualizing and exploring existing graphql APIs can be quite daunting. Using\npostman to manage all your apis is pretty standard, however creating and\nmaintaining collections is difficult. GraphMan makes thoses things easy, helping\nyou for:\n\n- Graph discovery\n- Graph testing\n- Collection updating\n\n## Usage\n\n### Run from url\n\n_GraphMan uses deno as a javascript / typescript runtime. That allows to run the\nCLI from the file url._ To get started:\n\n1. [Install deno](https://deno.land/#installation)\n2. Run:\n   `deno run https://deno.land/x/graphman@v1.2.2/src/cli.ts \u003cgraphql endpoint url\u003e`\n3. Import the generated `[...].postman_collection.json` file in postman.\n\n### Install GraphMan\n\nIf you want to access graphman easly you can \"install\" it on your machine:\n\n1. [Install deno](https://deno.land/#installation)\n2. Run:\n   `deno install -r -f --allow-net --allow-write -n graphman https://deno.land/x/graphman@v1.2.2/src/cli.ts`\n3. The command will output `export PATH=\"...\"` copy paste it in your `~/.bashrc`\n   or `~/.zshrc` file to add graphman to your path. You can now run graphman\n   using the `graphman \u003cparams\u003e` command! 🎉 To **update** GraphMan just\n   reproduce the **step 2**.\n\n_Note: this is not a real installation, it just creates a script that basically\naliases the run form url command._\n\n### Run locally\n\n1. Clone the repo\n2. Run `deno run src/index.ts \u003cparams\u003e`\n\n_Note that deno will ask for network and file-system permissions as it's runtime\nis secure by default_\n\nThe relases are mirrored at https://deno.land/x/graphman@VERSION, you can use\nprevious versions if needed.\n\n### CLI Options\n\n- Custom output filename: `--out=FILENAME`\n- Headers: `-H=\"header: value\"`, can be used multiple times.\n- Global Postman collection authorization header: `--AuthHeader=\"header: value\"`\n  or `-A=\"header: value\"`\n- Get help: `--help` or `-h`\n\n### Examples\n\nYou can try graphman on public graphql APIs, and it is a great way to get\nstarted with graphQL:\n\n- Rick\u0026Morty API:\n  `deno run https://deno.land/x/graphman@v1.2.2/src/cli.ts https://rickandmortyapi.com/graphql`\n\n| \u003cimg width=\"300\" src=\"https://raw.githubusercontent.com/Escape-Technologies/graphman/main/collection-example.png\"\u003e |\n| :----------------------------------------------------------------------------------------------------------------: |\n|                                  _GraphMan collection for the Rick and morty API_                                  |\n\n| \u003cimg width=\"500\" src=\"https://raw.githubusercontent.com/Escape-Technologies/graphman/main/query-example.png\"\u003e |\n| :-----------------------------------------------------------------------------------------------------------: |\n|                            _Character query for the Rick and morty API collection_                            |\n\n## Issues and contributions\n\n- Please open an issue if you encounter bugs, with reproduction steps and error\n  message.\n- For feature requests, please open an issue too\n- Feel free to create merge requests to improve GraphMan !\n","funding_links":[],"categories":["TypeScript","Tools","Neutral Security"],"sub_categories":["Tools - Editors \u0026 IDEs \u0026 Explorers","Self-Discovery"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FEscape-Technologies%2Fgraphman","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FEscape-Technologies%2Fgraphman","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FEscape-Technologies%2Fgraphman/lists"}