Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/YannickFricke/Dashed
https://github.com/YannickFricke/Dashed
Last synced: 4 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/YannickFricke/Dashed
- Owner: YannickFricke
- Created: 2022-02-18T23:38:37.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2022-02-20T14:43:03.000Z (about 3 years ago)
- Last Synced: 2024-08-01T19:37:24.440Z (7 months ago)
- Language: Elixir
- Size: 67.4 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Dashed
Dashed is a Elixir library for composing CLI commands through a custom DSL
(domain specific language).
## Installation
Please execute the following command to get the latest version of dashed:
`mix hex.info dashed`
Everything behind the `Config: ` string needs to be added to the `mix.exs` file.
```elixir
def deps do
[
{:dashed, "~> X.X.X"}
]
end
```
## Supported data types
- string
- integer
- float
- boolean
- list
## TODOs
- [ ] CLI Application
- [ ] Name
- [ ] Description
- [ ] Version
- [ ] Commands
- [ ] Input Parser
- [ ] Can make use of options (`Keyword.t()`)
- [ ] Supported data types
- [ ] string
- [ ] integer
- [ ] float
- [ ] boolean
- [ ] list
- [ ] Command
- [ ] Name
- [ ] Description
- [ ] Aliases
- [ ] Command Arguments
- [ ] Name
- [ ] Description
- [ ] Type (see [Supported data types](#supported-data-types))
- [ ] Required
- [ ] Rest of args (for list type)
- [ ] Command Flags
- [ ] Name
- [ ] Description
- [ ] Alias
- [ ] Type (see [Supported data types](#supported-data-types))
- [ ] Required
## Input parser
InputParsers are used for parsing the passed strings from the CLI into a Elixir
term.
They are used by the command arguments and command flags.