README
¶
Librarian CLI
This repository contains code for a unified command line tool for Google Cloud SDK client library configuration, generation and releasing.
See CONTRIBUTING.md for a guide to contributing to this repository, and the doc/ folder for more detailed project documentation.
The Librarian project supports the Google Cloud SDK ecosystem, and we do not expect it to be of use to external users. That is not intended to discourage anyone from reading the code and documentation; it's only to set expectations. (For example, we're unlikely to accept feature requests for external use cases.)
Installation
Install Go and make sure you have you have the
following in your PATH:
export PATH="$(go env GOPATH)/bin:$PATH"
Next install the CLI
go install github.com/googleapis/librarian/cmd/librarian@latest
Running Librarian
To see the current set of commands available, run:
librarian -help
Use the -help or -h flag for any individual command to see detailed
documentation for its purpose and associated flags. For example:
librarian generate -h
Alternatively, if you prefer not to have librarian installed you can use the Go command to run the latest released version:
go run github.com/googleapis/librarian/cmd/librarian@latest -help
Documentation
- CLI Documentation
- Language Onboarding Guide
- How We Write Go
- State Schema
- Config Schema)
- Running Tests
- sidekick
License
Apache 2.0 - See LICENSE for more information.
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
automation
command
Librarian manages Google API client libraries by automating onboarding, regeneration, and release.
|
Librarian manages Google API client libraries by automating onboarding, regeneration, and release. |
|
librarian
command
Librarian manages Google API client libraries by automating onboarding, regeneration, and release.
|
Librarian manages Google API client libraries by automating onboarding, regeneration, and release. |
|
sidekick
command
|
|
|
containers
module
|
|
|
internal
|
|
|
cli
Package cli defines a lightweight framework for building CLI commands.
|
Package cli defines a lightweight framework for building CLI commands. |
|
config
Package config defines configuration used by the CLI.
|
Package config defines configuration used by the CLI. |
|
docker
Package docker provides the interface for running language-specific Docker containers which conform to the Librarian container contract.
|
Package docker provides the interface for running language-specific Docker containers which conform to the Librarian container contract. |
|
github
Package github provides operations on GitHub repos, abstracting away go-github (at least somewhat) to only the operations Librarian needs.
|
Package github provides operations on GitHub repos, abstracting away go-github (at least somewhat) to only the operations Librarian needs. |
|
gitrepo
Package gitrepo provides operations on git repos.
|
Package gitrepo provides operations on git repos. |
|
librarian
Package librarian contains the business logic for the Librarian CLI.
|
Package librarian contains the business logic for the Librarian CLI. |
|
sidekick
Package sidekick provides functionality for automating code generation.
|
Package sidekick provides functionality for automating code generation. |
|
sidekick/internal/config
Package config provides functionality for working with the sidekick.toml configuration file.
|
Package config provides functionality for working with the sidekick.toml configuration file. |
|
sidekick/internal/external
Package external provides helper functions to work with external commands.
|
Package external provides helper functions to work with external commands. |
|
sidekick/internal/parser
Package parser reads specifications and converts them into the `genclient.API` model.
|
Package parser reads specifications and converts them into the `genclient.API` model. |
|
sidekick/internal/parser/svcconfig
serviceconfig contains helper functions to parse service config files.
|
serviceconfig contains helper functions to parse service config files. |
|
sidekick/internal/sample
Package sample provides sample data for testing.
|
Package sample provides sample data for testing. |