You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+18-11Lines changed: 18 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,6 @@
1
1
## Hammertime
2
2
3
-
A very basic, very untested, very unrefactored, and (likely) very unmaintained
4
-
CLI tool for interacting with [flintlock](https://github.com/weaveworks/flintlock) servers.
3
+
A very basic CLI tool for interacting with [flintlock](https://github.com/weaveworks/flintlock) servers.
5
4
6
5
(Those of you who know your archaic gun mechanisms will understand the name and no doubt
7
6
find it hilarious.) (You are welcome.)
@@ -10,6 +9,15 @@ Why did I make this? Well we used to use another generic GRPC client, but we dis
10
9
that, for reasons I do not yet know, it [didn't like some of the enum values we returned](https://github.com/weaveworks/flintlock/issues/313#issuecomment-991015159).
11
10
So here we are.
12
11
12
+
I have kept it around because it makes working with flintlock very straightforward.
13
+
14
+
### Versioning
15
+
16
+
Latest of hammertime is always aligned with latest of flintlock.
17
+
Check the release notes for potential breakages.
18
+
19
+
TODO compatibility table
20
+
13
21
### Installation
14
22
15
23
1. Build from source:
@@ -28,25 +36,24 @@ Alias to `ht` if you like.
28
36
29
37
### Usage
30
38
31
-
4 commands, very few configuration options. Everything has defaults so you don't need
32
-
to pass any flags at all if you don't want to. Each command simply spits out the response
39
+
4 commands, very few configuration options. Each command simply spits out the response
33
40
as JSON so you can pipe to `jq` or whatever as you like.
34
41
35
42
```bash
36
-
# create 'mvm0' in 'ns0'
43
+
# create 'mvm0' in 'ns0' (take note of the UID after creation)
37
44
hammertime create
38
45
39
-
# get 'mvm0' in 'ns0'
40
-
hammertime get
46
+
# get
47
+
hammertime get -i <UUID>
41
48
42
49
# get just the state of 'mvm0' in 'ns0' *see below
43
-
hammertime get -s
50
+
hammertime get -i <UUID> -s
44
51
45
-
# get all mvms in 'ns0'
52
+
# get all mvms
46
53
hammertime list
47
54
48
-
# delete 'mvm0' from 'ns0'
49
-
hammertime delete
55
+
# delete
56
+
hammertime delete -i <UID>
50
57
```
51
58
52
59
The name and namespace are configurable, as are the GRPC address and port.
0 commit comments