{"id":16227888,"url":"https://github.com/shiryel/graphme","last_synced_at":"2025-04-08T04:30:42.694Z","repository":{"id":57503221,"uuid":"397758852","full_name":"shiryel/graphme","owner":"shiryel","description":"A Elixir Mix Task to generate a relationship graph of your project modules using the DOT language","archived":false,"fork":false,"pushed_at":"2021-08-19T18:49:32.000Z","size":14,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-02-14T03:18:22.082Z","etag":null,"topics":["documentation-generator","documentation-tool","elixir","graphviz","graphviz-dot"],"latest_commit_sha":null,"homepage":"https://hexdocs.pm/graphme","language":"Elixir","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/shiryel.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":null,"security":null,"support":null}},"created_at":"2021-08-18T23:21:29.000Z","updated_at":"2022-08-04T12:26:16.000Z","dependencies_parsed_at":"2022-08-31T08:02:08.488Z","dependency_job_id":null,"html_url":"https://github.com/shiryel/graphme","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shiryel%2Fgraphme","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shiryel%2Fgraphme/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shiryel%2Fgraphme/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shiryel%2Fgraphme/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/shiryel","download_url":"https://codeload.github.com/shiryel/graphme/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247779620,"owners_count":20994567,"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":["documentation-generator","documentation-tool","elixir","graphviz","graphviz-dot"],"created_at":"2024-10-10T12:54:05.688Z","updated_at":"2025-04-08T04:30:42.668Z","avatar_url":"https://github.com/shiryel.png","language":"Elixir","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Graphme\n\nGenerates a relationship graph of your project modules using the DOT language\n\n## How to run\n\nYou need the following deps installed on your system:\n* elixir\n* dot (graphviz)\n\nNow you can run:\n```bash\n  mix graphme\n```\n\n## Installation\n\nThe package can be installed by adding `graphme` to your list of dependencies in `mix.exs`:\n\n```elixir\ndef deps do\n  [\n    {:graphme, \"~\u003e 0.1.0\", only: :dev, runtime: false}\n  ]\nend\n```\n\nThe docs can be found at [https://hexdocs.pm/graphme](https://hexdocs.pm/graphme).\n\n## Command line options\n\n  * `-f` `--filter` - One part of a module name, eg: from A.B.C you can filter the B [default: nil]\n  * `-F` `--filter_at` - The index of a module name part, eg: from A.B.C you can use `1` to filter B [default: 0]\n  * `-S` `--subgraph_at` - The index of a module name part that will be used to clusterize the graph [default: nil]\n  * `-o` `--output` - The output file name [default: graph]\n  * `-O` `--output_format` - The output file format, eg: svg, png [default: png]\n\n## Examples\nFilter the modules using the first (0) module name and output as \"my_graph.svg\"\n\n    mix graphme -f \"YourModulePart\" -F 0 -S \"AnotherModulePart\" -o \"my_graph\" -O \"svg\"\n\n## License\n\n   Copyright 2021 Shiryel\n\n   Licensed under the Apache License, Version 2.0 (the \"License\");\n   you may not use this file except in compliance with the License.\n   You may obtain a copy of the License at\n\n       http://www.apache.org/licenses/LICENSE-2.0\n\n   Unless required by applicable law or agreed to in writing, software\n   distributed under the License is distributed on an \"AS IS\" BASIS,\n   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n   See the License for the specific language governing permissions and\n   limitations under the License.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshiryel%2Fgraphme","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fshiryel%2Fgraphme","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshiryel%2Fgraphme/lists"}