1
- [ ![ codecov] ( https://codecov.io/github/googleapis/librarian/graph/badge.svg?token=33d3L7Y0gN )] ( https://codecov.io/github/googleapis/librarian )
2
1
# Librarian CLI
3
2
3
+ [ ![ Go Reference] ( https://pkg.go.dev/badge/github.com/googleapis/librarian/cmd/librarian.svg )] ( https://pkg.go.dev/github.com/googleapis/librarian/cmd/librarian )
4
+ [ ![ codecov] ( https://codecov.io/github/googleapis/librarian/graph/badge.svg?token=33d3L7Y0gN )] ( https://codecov.io/github/googleapis/librarian )
5
+
4
6
This repository contains code for a unified command line tool for
5
7
Google Cloud SDK client library configuration, generation and releasing.
6
8
@@ -13,35 +15,53 @@ intended to discourage anyone from reading the code and documentation;
13
15
it's only to set expectations. (For example, we're unlikely to accept
14
16
feature requests for external use cases.)
15
17
18
+ ## Installation
19
+
20
+ Install [ Go] ( https://go.dev/doc/install ) and make sure you have you have the
21
+ following in your ` PATH ` :
22
+
23
+ ``` sh
24
+ export PATH=" $( go env GOPATH) /bin:$PATH "
25
+ ```
26
+
27
+ Next install the CLI
28
+
29
+ ``` sh
30
+ go install github.com/googleapis/librarian/cmd/librarian@latest
31
+ ```
32
+
16
33
## Running Librarian
17
34
18
35
To see the current set of commands available, run:
19
36
20
37
``` sh
21
- go run ./cmd/ librarian
38
+ librarian -help
22
39
```
23
40
24
- Use the ` -h ` flag for any individual command to see detailed
41
+ Use the ` -help ` or ` - h` flag for any individual command to see detailed
25
42
documentation for its purpose and associated flags. For example:
26
43
27
44
``` sh
28
- go run ./cmd/ librarian generate -h
45
+ librarian generate -h
29
46
```
30
47
31
- Most commands require a language-specific image to be available;
32
- there are no such images published at the moment.
48
+ Alternatively, if you prefer not to have librarian installed you can use the Go
49
+ command to run the latest released version:
33
50
34
- See https://pkg.go.dev/github.com/googleapis/librarian/cmd/librarian for
35
- additional documentation.
51
+ ``` sh
52
+ go run github.com/googleapis/librarian/cmd/librarian@latest -help
53
+ ```
36
54
37
- ## Running Tests
55
+ ## Documentation
38
56
39
- See [ testing.md] for more information.
57
+ - [ CLI Documentation] ( https://pkg.go.dev/github.com/googleapis/librarian/cmd/librarian )
58
+ - [ Language Onboarding Guide] ( doc/language-onboarding.md )
59
+ - [ How We Write Go] ( doc/howwewritego.md )
60
+ - [ State Schema] ( doc/state-schema.md )
61
+ - [ Config Schema] ( doc/config-schema.md ) )
62
+ - [ Running Tests] ( doc/testing.md )
63
+ - [ sidekick] ( doc/sidekick.md )
40
64
41
65
## License
42
66
43
- Apache 2.0 - See [ LICENSE] for more information.
44
-
45
- [ contributing ] : CONTRIBUTING.md
46
- [ license ] : LICENSE
47
- [ testing.md ] : doc/testing.md
67
+ Apache 2.0 - See [ LICENSE] ( LICENSE ) for more information.
0 commit comments