{"id":18051622,"url":"https://github.com/zoedsoupe/nexus","last_synced_at":"2025-07-11T13:41:20.876Z","repository":{"id":175693401,"uuid":"618709291","full_name":"zoedsoupe/nexus","owner":"zoedsoupe","description":"CLI framework for Elixir, with magic!","archived":false,"fork":false,"pushed_at":"2024-12-05T20:24:52.000Z","size":70,"stargazers_count":33,"open_issues_count":6,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-06T07:59:15.844Z","etag":null,"topics":["cli","cli-framework","elixir"],"latest_commit_sha":null,"homepage":"https://hexdocs.pm/nexus_cli","language":"Elixir","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"wtfpl","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/zoedsoupe.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","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},"funding":{"github":"zoedsoupe","patreon":null,"open_collective":"zoedsoupe","ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"lfx_crowdfunding":null,"polar":null,"buy_me_a_coffee":null,"thanks_dev":null,"custom":null}},"created_at":"2023-03-25T05:40:46.000Z","updated_at":"2025-03-25T00:58:11.000Z","dependencies_parsed_at":null,"dependency_job_id":"80220dd3-3049-4266-b256-55f24083a4d2","html_url":"https://github.com/zoedsoupe/nexus","commit_stats":null,"previous_names":["zoedsoupe/nexus"],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zoedsoupe%2Fnexus","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zoedsoupe%2Fnexus/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zoedsoupe%2Fnexus/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zoedsoupe%2Fnexus/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zoedsoupe","download_url":"https://codeload.github.com/zoedsoupe/nexus/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248262434,"owners_count":21074308,"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":["cli","cli-framework","elixir"],"created_at":"2024-10-30T22:51:54.091Z","updated_at":"2025-07-11T13:41:20.854Z","avatar_url":"https://github.com/zoedsoupe.png","language":"Elixir","funding_links":["https://github.com/sponsors/zoedsoupe","https://opencollective.com/zoedsoupe"],"categories":[],"sub_categories":[],"readme":"# Nexus\n\n```sh\n     _      __\n|\\ ||_\\/| |(_\n| \\||_/\\|_|__)\n```\n\n\u003e Create CLIs in a magic and declarative way!\n\nA pure `Elixir` library to write command line apps in a cleaner and elegant way!\n\n[![Hex.pm](https://img.shields.io/hexpm/v/nexus_cli.svg)](https://hex.pm/packages/nexus_cli)\n[![Downloads](https://img.shields.io/hexpm/dt/nexus_cli.svg)](https://hex.pm/packages/nexus_cli)\n[![Documentation](https://img.shields.io/badge/documentation-gray)](https://hexdocs.pm/nexus_cli)\n[![ci](https://github.com/zoedsoupe/nexus/actions/workflows/ci.yml/badge.svg)](https://github.com/zoedsoupe/nexus/actions/workflows/ci.yml)\n\n## Installation\n\nJust add the `nexus_cli` package to your `mix.exs`\n\n```elixir\ndef deps do\n  [\n    {:nexus_cli, \"~\u003e 0.5\"}\n  ]\nend\n```\n\n## Example\n\n```elixir\ndefmodule MyCLI do\n  @moduledoc \"This will be used into as help\"\n\n  use Nexus.CLI\n\n  defcommand :fizzbuzz do\n    description \"Plays fizzbuzz - this will also be used as help\"\n\n    value :integer, required: true\n  end\n\n  @impl Nexus.CLI\n  def handle_input(:fizzbuzz, %{value: value}) when is_integer(value) do\n    cond do\n      rem(value, 3) == 0 and rem(value, 5) == 0 -\u003e IO.puts(\"fizzbuzz\")\n      rem(value, 3) == 0 -\u003e IO.puts(\"fizz\")\n      rem(value, 5) == 0 -\u003e IO.puts(\"buzz\")\n      true -\u003e IO.puts value\n    end\n  end\nend\n```\n\nMore different ways to use this library can be found on the [examples](./examples) folder\nDocumentation on defining a CLI module can be found at the [Nexus.CLI](https://hexdocs.pm/nexus_cli/Nexus.CLI.html)\n\n# Roadmap\n\n| Feature                          | Status       | Description                                                                                   |\n|----------------------------------|--------------|-----------------------------------------------------------------------------------------------|\n| **Core Nexus.CLI Implementation**| ✅ Completed  | Base implementation of the `Nexus.CLI` module with macro-based DSL for defining CLIs.         |\n| **Automatic Help Generation**    | ✅ Completed  | Automatically generate help messages based on command definitions.                            |\n| **Command Parsing and Dispatching**| ✅ Completed| Parse user input and dispatch commands to the appropriate handlers.                           |\n| **Nexus.TUI Development**        | 🚧 In Progress | Build the `Nexus.TUI` module leveraging Phoenix LiveView and TEA for terminal UIs.           |\n| **TUI Component Library**        | 🔜 Planned    | Develop reusable components for building terminal UIs.                                        |\n| **Integration with Phoenix LiveView**| 🔜 Planned| Integrate `Nexus.TUI` with Phoenix LiveView for live terminal experiences.                    |\n| **Community Contributions**      | ♾️ Ongoing    | Encourage and incorporate feedback and contributions from the community.                      |\n\n### Features\n- Macro based DSL\n  - [x] define global/root commands\n  - [x] define subcommands (supporting nesting)\n  - [x] define flags\n  - [ ] define global/root flags\n- [x] Automatic help flags generation\n\n## Why \"Nexus\"\n\nNexus is a connection from two different worlds! This library connects the world of CLIs with the magic world of `Elixir`!\n\n## Inspirations\n\nHighly inspired in [clap-rs](https://github.com/clap-rs/clap/)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzoedsoupe%2Fnexus","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzoedsoupe%2Fnexus","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzoedsoupe%2Fnexus/lists"}