Skip to content

Commit

Permalink
README.md: add TL;DR; section
Browse files Browse the repository at this point in the history
  • Loading branch information
gportay committed Feb 2, 2025
1 parent ee53bfd commit dec7777
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,19 @@

[![Packaging status](https://repology.org/badge/vertical-allrepos/dosh.svg)](https://repology.org/project/dosh/versions)

## TL;DR;

[dosh][dosh(1)] is a bash script providing a shell CLI to *docker-run(1)*.

It runs a user shell with cwd bind mounted to the container built using the
Dockerfile.

One think `dosh` does...

docker run --rm [--tty] [--interactive] "--volume=$PWD:$PWD:rw" "--user=$USER" "--entry-point=$SHELL" IMAGE [SHELL_ARGS]

... with a few more magic!

## NAME

[dosh][dosh(1)] - run a user shell in a container with cwd bind mounted
Expand Down

0 comments on commit dec7777

Please sign in to comment.