Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/khusnetdinov/loki
:pencil: Loki is library that includes helpers for building powerful interactive command line applications, tasks, modules.
https://github.com/khusnetdinov/loki
elixir elixir-lang elixir-library elixir-phoenix loki
Last synced: 4 days ago
JSON representation
:pencil: Loki is library that includes helpers for building powerful interactive command line applications, tasks, modules.
- Host: GitHub
- URL: https://github.com/khusnetdinov/loki
- Owner: khusnetdinov
- License: mit
- Created: 2016-11-25T13:01:18.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2023-10-10T16:59:40.000Z (about 1 year ago)
- Last Synced: 2024-10-09T13:07:48.837Z (25 days ago)
- Topics: elixir, elixir-lang, elixir-library, elixir-phoenix, loki
- Language: Elixir
- Homepage:
- Size: 71.3 KB
- Stars: 88
- Watchers: 4
- Forks: 7
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- freaking_awesome_elixir - Elixir - Library for creating interactive command-line application. (Command Line Applications)
- fucking-awesome-elixir - loki - Library for creating interactive command-line application. (Command Line Applications)
- awesome-elixir - loki - Library for creating interactive command-line application. (Command Line Applications)
README
# Loki [](https://www.codetriage.com/khusnetdinov/loki) [](https://travis-ci.org/khusnetdinov/loki) [](https://hex.pm/packages/loki) [](https://ebertapp.io/github/khusnetdinov/loki)
Loki is a toolkit for building powerful command-line interfaces.
## Example
## Instalation
Add `loki` to your list of dependencies in `mix.exs`:
```elixir
def deps do
[{:loki, "~> 1.2.2"}]
end
```
## Usage
Import all or desired module to scope:
```elixir
defmodule Project do
# Import all modules
use Loki
# Or import single modules
import Loki.Shell
import Loki.Cmd
import Loki.Directory
import Loki.File
import Loki.FileManipulation
...
end
```
## Modules
### Loki.Shell
Helpers for interaction with user and printing message to shell.
- `ask/2` - Ask user input with given message. Returns tuple with parsed options.
- `yes?/1` - Ask about positive user input with given message.
- `no?/1` - Ask about negative user input with given message.
- `say/1` - Printing message to shell.
- `say_create/1` - Printing message about create file to shell.
- `say_force/1` - Printing message about force action to shell.
- `say_identical/1` - Printing message about identical files content to shell.
- `say_skip/1` - Printing message about skipping action to shell.
- `say_error/1` - Printing message about to shell.
- `say_conflict/1` - Printing message about conflict to shell.
- `say_exists/1` - Printing message about existance to shell.
- `say_rename/2` - Printing message about rename files to shell.
- `say_copy/2` - Printing message about copy files to shell.
- `say_remove/1` - Printing message about removing file to shell.
### Loki.Cmd
Executing terminal commands helpers.
- `execute/1` - Execute shell command with Env variables as options.
- `execute_in_path/2` - Execute shell command with Env variables as options in given path.
- `format_output/1` - Format execution output for reading in shell.
### Loki.Directory
Working with folders helpers.
- `create_directory/1` - Helper for create directory.
- `exists_directory?/1` - Helper for checking if file exists.
- `copy_directory/2` - Helper for copy directory.
- `remove_directory/1` - Helper for remove directory.
### Loki.File
Helpers for working with file.
- `create_file/1` - Helper for create file.
- `create_file_force/1` - Helper for create file in force mode.
- `exists_file?/1` - Helper check if file exists.
- `identical_file?/2` - Helper check if file identical.
- `copy_file/2` - Helper for copy files.
- `create_link/2` - Helper for create link.
- `remove_file/1` - Helper for remove file.
- `rename/2` - Helper for rename files and dirs.
### Loki.FileManipulation
Helpers for content manipulation injecting, appending, and other.
- `append_to_file/2` - Helper appends lines to file.
- `prepend_to_file/2` - Helper prepends lines to file.
- `remove_from_file/2` - Helper removes lines from file.
- `inject_into_file/3` - Helper injecting lines to file with `before` and `after` options.
- `replace_in_file/3` - Helper replaces lines in file.
- `comment_in_file/2` - Helper comments line in file.
- `uncomment_in_file/2` - Helper uncomments lines in file.
- `remove_comments_in_file` - Helper removes all comments in file.
## Documentation
[Read hexdocs.pm](https://hexdocs.pm/loki/api-reference.html)
## Contribution
Clone repo, implement additional helpers, write tests and PR welcome!
## License
The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).