Skip to content
This repository was archived by the owner on Sep 17, 2018. It is now read-only.

Commit eae86b8

Browse files
committed
Add README
1 parent 0054455 commit eae86b8

1 file changed

Lines changed: 68 additions & 0 deletions

File tree

README.md

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
dev
2+
===
3+
4+
A small tool for provisioning development Docker containers.
5+
6+
```
7+
dev version 0.1
8+
9+
Usage: dev [command] <manifest>
10+
11+
if manifest is undefined the default value
12+
.dev.yaml will be used.
13+
14+
Available commands:
15+
DOWN Destroys a development container
16+
UP Brings up a development container
17+
```
18+
19+
A manifest is just a super-simple `.yaml` file that describes the container to
20+
provision.
21+
22+
```yaml
23+
base: xena/dev-moonscript # image to launch Docker with
24+
repopath: github.com/Xe/dev/spike # repo path for mounting $CURDIR
25+
golang: false # Go has a more opinionated package store
26+
ssh: true # pass through ssh keys?
27+
user: xena # user in the docker container
28+
projname: spike # project name
29+
```
30+
31+
## Usage
32+
33+
Usage is simple:
34+
35+
```console
36+
$ dev up
37+
Starting up container for spike
38+
spike-dev (43c5c1) running!
39+
To use this container please attach to it with:
40+
$ docker attach spike-dev
41+
$ docker attach spike-dev
42+
docker:dev:spike ~
43+
-->
44+
```
45+
46+
```console
47+
$ dev down
48+
Container destroyed.
49+
$
50+
```
51+
52+
## Installation
53+
54+
This is a tool in Moonscript and thus requires you have the moonscript binary
55+
installed. No other dependencies are required other than the `docker` client
56+
binary.
57+
58+
Copy `dev.moon` to a place that is in your `PATH` environment variable.
59+
I personally get away with the following:
60+
61+
```console
62+
$ cp dev.moon ~/bin/dev
63+
```
64+
65+
---
66+
67+
This tool Works For Me and patches/feature/problem requests are welcome in the
68+
issue tracker. Please keep any patches simple.

0 commit comments

Comments
 (0)