polypush135

polypush135

CLI basics. How to handle input requirements?

I’m trying build a basic cli app for the purpose of learning.

Lets say we are making a basic cli for counting words of one or more txt documents

The requirement of my app is as listed:

  • The program accepts as arguments a list of one or more file paths (e.g. ./wordcount file1.txt file2.txt …).
  • The program also accepts input on stdin (e.g. cat file1.txt | ./wordcount).

First of all here is my current working example of a cli escript app. https://gist.github.com/joshchernoff/4a6678a555f61edc771649576c344f58

One of the things not listed that bothered me was the app would just hang if no input via args or sdtin was given.

I understand the app was just waiting for input from the terminal and if I typed it would read via IO.read, but I would think that it would be more helpful that I gave an error if no input was given and then just stop the app.

I didn’t realize that it’s a common thing for stdio to just wait there.

I guess at this point I’m at a loss for common bast practices.

  • should the app just hang expecting some form of stdin?
  • should the app be smart and see nothing is happening and report according?
  • should I have an explicit flag that denotes how I want to explicitly use the app?

Sorry for such a open ended question, its just that this was also a part of a tech challenge for a job interview that I completely tanked today. Not feeling very good about myself right now. I wish I had a better understanding of standards and this type of utility apps feels very foreign to me as primarily a web developer just starting to make phoenix apps.

Most Liked

cmkarlsson

cmkarlsson

It is very common for command line applications to just wait for input if no arguments are given.

For example: cat, grep, wc, sed, awk, sed and many others. Try these without a file argument and they will just hang there and wait for input. Use Ctrl-D to give eof

None of these applications warn if there is no standard input as that is the normal way they work and it is what make them easy to use in pipes.

Other command line applications have a flag or use dash - instead of the filename to specify that you want them to read from standard in. For example: xmllint, (I know there are many more but can’t think of one now). This way you can show them a help text indicating that they need to provide a filename or - for stdin if they haven’t provided any arguments.

It is also common to write things to standard out, or at least give an option to write to standard out instead of a file. For example wget allows you to specify and outfile with -O filename but the option to write to standard out with -O -. Funnily enough curl works the other way around where the default is to write to standard out but you can save to a file with -o filename.

As I almost exclusively work with command line applications I think a well behaved command line app should

  • Support reading and writing from stdin/stdout (if it makes sense for the application). I don’t mind if I have to provide a flag for this
  • Write errors and warnings to stderr
  • Return correct error codes 0 for success. non zero for failure.
  • Have a man page with good descriptions and examples. This is getting less common
  • Have a short hand help through -h or --help. I like this to be short and fit on a page. The rest is for man.
  • Have a non-interactive flag if normally interactive (so that things can get automated)
  • Likely more which I haven’t thought about :smiley:

So perhaps your cli app can do this (just an example).


$ ./wordcount
Usage: wordcount OPTION... [FILE]...
Counts words in each FILE and print to standard output

When FILE is -, read standard input.

OPTIONS are:

  -i, --ignore=REGEX  Ignore words matching REGEX

$ ./wordcount --help
Usage: wordcount OPTION... [FILE]...
Counts words in each FILE and print to standard output

When FILE is -, read standard input.

OPTIONS are:

  -i, --ignore=REGEX  Ignore words matching REGEX

$ ./wordcount hello.txt
32

$ cat hello.txt | ./wordcount -
32

$ ./wordcount hello.txt world.txt
132

Where Next?

Popular in Questions Top

New
Fl4m3Ph03n1x
About me? ( if you have nothing better to do than reading about some random guy in the internet :stuck_out_tongue: ) Hello all, this is ...
New
ycv005
I have followed this StackOverflow post to install the specific version of Erlang. And When I am running mix ecto.setup then getting fol...
New
dokuzbir
I want to highlight html closing tags when i click a html tag. That works in .html files but doesnt work for html.eex templates. How can...
New
joeerl
Hello again - after a longish gap I’ve decided I really must dig into Elixir and see what’s been happening here - so I have a few questio...
New
belgoros
I’m not a pro in using Regex and can’t figure out why the following behaviour happens, especially if we take into account the difference ...
New
freewebwithme
Using vs code and installed ElixirLS: support and debugger. And I got an error popped up on start up says Failed to run ‘elixir’ comma...
New
romenigld
I am trying to run a deploy with docker and I successfully runned with this command: docker build -t romenigld/blog-prod . but when I t...
New
hariharasudhan94
I would like to know what is the best IDE for elixir development?
New
vonH
In asking this question I am more interested about the expressiveness of the language itself and less concerned about the availability of...
New

Other popular topics Top

albydarned
Hello all! I am typing this post from my new MacBook Pro with the M1 chip. I’m loving it so far, and will probably use it as my daily dr...
New
gshaw
What is the idiomatic way of matching for not nil in Elixir? E.g., First way: defp halt_if_not_signed_in(conn, signed_in_account) when...
New
fireproofsocks
Forgive me if this is obvious, but how does one delete a database record WITHOUT selecting it first? Ecto.Repo — Ecto v3.14.0 has exampl...
New
msaraiva
Surface is an experimental library built on top of Phoenix LiveView and its new LiveComponent API that aims to provide a more declarative...
564 43622 214
New
stefanchrobot
What’s the safe way to decode a JSON string into a struct? I want to avoid calling String.to_atom. Jason.decode can give me a map with st...
New
joeerl
Hello again - after a longish gap I’ve decided I really must dig into Elixir and see what’s been happening here - so I have a few questio...
New
pmjoe
I have a relationship of love and hate with Elixir. Lots of things are just absolutely right, but there are some things that are kind of ...
New
nsuchy
Hi. I’ve noticed that Windows Powershell has it’s own IEX command and you cannot access Elixir’s IEX due to the conflict. This isn’t a cr...
New
klo
Got a question about when to concat vs. prepending items to list then reversing to achieve appending. So i know lists boil down to [1 | ...
New
svb
Hi! Currently I want to submit a form by pressing the Enter key. However, since my input field is of type “textarea” this is just adds a...
New

We're in Beta

About us Mission Statement