Skip to content

Commit

Permalink
add setup & usafe README
Browse files Browse the repository at this point in the history
  • Loading branch information
ak1ra24 committed Dec 28, 2019
1 parent 8e7ced3 commit 506c86e
Showing 1 changed file with 17 additions and 4 deletions.
21 changes: 17 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,43 @@
# tinet-go

![](https://github.com/ak1ra24/tinet-go/workflows/golangci/badge.svg)
[![Go Report Card](https://goreportcard.com/badge/github.com/ak1ra24/tinet-go)](https://goreportcard.com/report/github.com/ak1ra24/tinet-go)
![](https://github.com/ak1ra24/tinet-go/workflows/golangci/badge.svg) [![Go Report Card](https://goreportcard.com/badge/github.com/ak1ra24/tinet-go)](https://goreportcard.com/report/github.com/ak1ra24/tinet-go)

Go implement of [slankdev/tinet](https://github.com/slankdev/tinet).

:warning: Operation check is still

## Setup
```
curl https://github.com/ak1ra24/tinet-go/releases/download/v0.0.0/tinet-go_linux_amd64.tar.gz | tar zx -C /usr/local/bin
wgethttps://github.com/ak1ra24/tinet-go/releases/download/v0.0.0/tinet-go_linux_amd64.tar.gz -P /tmp
tar zxvf /tmp/tinet-go_linux_amd64.tar.gz -C /usr/local/bin
```

## Usage
```
tn up -c spec.yaml | sudo sh -x
tn conf -c spec.yaml | sudo sh -x
tn test -c spec.yaml | sudo sh -x
tn down -c spec.yaml | sudo sh -x
```

## Command Options

```
➜ tn
tinet is network simultulator created by docker
Usage:
tn [command]
Available Commands:
build Generate a Docker bundle from the spec file
check check config
completion Generates shell completion scripts
conf Execute config-cmd in a running container
down Stop and remove containers
exec Execute a command in a running container
help Help about any command
img Generate topology png file by graphviz
init Generate template spec file
print print tinet config file
ps List services
Expand All @@ -41,4 +54,4 @@ Flags:
Use "tn [command] --help" for more information about a command.
```
```

0 comments on commit 506c86e

Please sign in to comment.