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
License
Apache 2.0 - See LICENSE for more information.
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
legacyautomation
command
Automation provides logic to trigger Cloud Build jobs that run Librarian commands for any repository listed in internal/legacylibrarian/legacyautomation/prod/repositories.yaml.
|
Automation provides logic to trigger Cloud Build jobs that run Librarian commands for any repository listed in internal/legacylibrarian/legacyautomation/prod/repositories.yaml. |
|
legacylibrarian
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 CLI runs local workflow that
|
Librarian CLI runs local workflow that |
|
librarianops
command
Librarianops orchestrates librarian operations across multiple repositories.
|
Librarianops orchestrates librarian operations across multiple repositories. |
|
surfer
command
Command surfer generates gcloud command YAML files.
|
Command surfer generates gcloud command YAML files. |
|
containers
module
|
|
|
internal
|
|
|
command
Package command provides helpers to execute external commands with logging.
|
Package command provides helpers to execute external commands with logging. |
|
config
Package config provides types and functions for reading and writing librarian.yaml configuration files.
|
Package config provides types and functions for reading and writing librarian.yaml configuration files. |
|
config/bazel
Package bazel parses BUILD.bazel files to extract GAPIC configuration.
|
Package bazel parses BUILD.bazel files to extract GAPIC configuration. |
|
config/gapicyaml
Package gapicyaml provides parsing for GAPIC YAML configuration files.
|
Package gapicyaml provides parsing for GAPIC YAML configuration files. |
|
docuploader
Package docuploader provides functionality for packaging documentation for googleapis.dev and cloud.google.com.
|
Package docuploader provides functionality for packaging documentation for googleapis.dev and cloud.google.com. |
|
fetch
Package fetch provides utilities for fetching GitHub repository metadata and computing checksums.
|
Package fetch provides utilities for fetching GitHub repository metadata and computing checksums. |
|
git
Package git provides functions for determining changes in a git repository.
|
Package git provides functions for determining changes in a git repository. |
|
legacylibrarian/legacyautomation
Package legacyautomation implements the command-line interface and core logic for Librarian's automated workflows.
|
Package legacyautomation implements the command-line interface and core logic for Librarian's automated workflows. |
|
legacylibrarian/legacycli
Package legacycli defines a lightweight framework for building CLI commands.
|
Package legacycli defines a lightweight framework for building CLI commands. |
|
legacylibrarian/legacyconfig
Package legacyconfig defines configuration used by the CLI.
|
Package legacyconfig defines configuration used by the CLI. |
|
legacylibrarian/legacycontainer/java/bazel
Package bazel provides utilities for parsing BUILD.bazel files.
|
Package bazel provides utilities for parsing BUILD.bazel files. |
|
legacylibrarian/legacycontainer/java/execv
Package execv provides a helper function for executing external commands.
|
Package execv provides a helper function for executing external commands. |
|
legacylibrarian/legacycontainer/java/languagecontainer
Package languagecontainer defines LanguageContainer interface and the Run function to execute commands within the container.
|
Package languagecontainer defines LanguageContainer interface and the Run function to execute commands within the container. |
|
legacylibrarian/legacycontainer/java/languagecontainer/generate
Package generate contains types for language container's generate command.
|
Package generate contains types for language container's generate command. |
|
legacylibrarian/legacycontainer/java/languagecontainer/release
Package release contains types for language container's release command.
|
Package release contains types for language container's release command. |
|
legacylibrarian/legacycontainer/java/message
Package message defines data types which the Librarian CLI and language containers exchange.
|
Package message defines data types which the Librarian CLI and language containers exchange. |
|
legacylibrarian/legacycontainer/java/pom
Package pom handles the generation of Maven pom.xml files for a Java library.
|
Package pom handles the generation of Maven pom.xml files for a Java library. |
|
legacylibrarian/legacycontainer/java/protoc
Package protoc provides utilities for constructing protoc command arguments.
|
Package protoc provides utilities for constructing protoc command arguments. |
|
legacylibrarian/legacycontainer/java/release
Package release contains the implementation of the release-stage command.
|
Package release contains the implementation of the release-stage command. |
|
legacylibrarian/legacydocker
Package legacydocker provides the interface for running language-specific Docker containers which conform to the Librarian container contract.
|
Package legacydocker provides the interface for running language-specific Docker containers which conform to the Librarian container contract. |
|
legacylibrarian/legacygithub
Package legacygithub provides operations on GitHub repos, abstracting away go-github (at least somewhat) to only the operations Librarian needs.
|
Package legacygithub provides operations on GitHub repos, abstracting away go-github (at least somewhat) to only the operations Librarian needs. |
|
legacylibrarian/legacygitrepo
Package legacygitrepo provides operations on git repos.
|
Package legacygitrepo provides operations on git repos. |
|
legacylibrarian/legacyimages
Package legacyimages provides operations around docker images.
|
Package legacyimages provides operations around docker images. |
|
legacylibrarian/legacyintegration
Package integration contains integration and e2e tests for the Librarian project.
|
Package integration contains integration and e2e tests for the Librarian project. |
|
legacylibrarian/legacylibrarian
Package legacylibrarian provides the core implementation for the Librarian CLI tool.
|
Package legacylibrarian provides the core implementation for the Librarian CLI tool. |
|
librarian
Package librarian provides functionality for onboarding, generating and releasing Google Cloud client libraries.
|
Package librarian provides functionality for onboarding, generating and releasing Google Cloud client libraries. |
|
librarian/dart
Package dart provides functionality for generating and releasing Dart client libraries.
|
Package dart provides functionality for generating and releasing Dart client libraries. |
|
librarian/golang
Package golang provides functionality for generating Go client libraries.
|
Package golang provides functionality for generating Go client libraries. |
|
librarian/python
Package python provides Python specific functionality for librarian.
|
Package python provides Python specific functionality for librarian. |
|
librarian/rust
Package rust provides Rust specific functionality for librarian.
|
Package rust provides Rust specific functionality for librarian. |
|
librarianops
Package librarianops provides orchestration for running librarian across multiple repositories.
|
Package librarianops provides orchestration for running librarian across multiple repositories. |
|
license
Package license provides functions for generating license header text.
|
Package license provides functions for generating license header text. |
|
repometadata
Package repometadata represents the data in .repo-metadata.json files, and the ability to create those files from other Librarian configuration.
|
Package repometadata represents the data in .repo-metadata.json files, and the ability to create those files from other Librarian configuration. |
|
sample
Package sample provides functionality for generating sample values of the types contained in the internal package for testing purposes.
|
Package sample provides functionality for generating sample values of the types contained in the internal package for testing purposes. |
|
semver
Package semver provides functionality for parsing, comparing, and manipulating semantic version strings according to the SemVer 1.0.0 and 2.0.0 spec.
|
Package semver provides functionality for parsing, comparing, and manipulating semantic version strings according to the SemVer 1.0.0 and 2.0.0 spec. |
|
serviceconfig
Package serviceconfig reads and parses API service config files.
|
Package serviceconfig reads and parses API service config files. |
|
sidekick/api
Package api defines the data model representing a parsed API surface.
|
Package api defines the data model representing a parsed API surface. |
|
sidekick/api/apitest
Package apitest provides helper functions for testing the api package.
|
Package apitest provides helper functions for testing the api package. |
|
sidekick/codec_sample
Package codec_sample provides an example implementation of a code generator.
|
Package codec_sample provides an example implementation of a code generator. |
|
sidekick/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/dart
Package dart implements a native Dart code generator.
|
Package dart implements a native Dart code generator. |
|
sidekick/language
Package language provides common utilities for language-specific code generation
|
Package language provides common utilities for language-specific code generation |
|
sidekick/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/parser/discovery
Package discovery parses Google Discovery Documents into the sidekick abstract API model (`api.API`).
|
Package discovery parses Google Discovery Documents into the sidekick abstract API model (`api.API`). |
|
sidekick/parser/httprule
Package httprule provides a parser for the path templates found in [google.api.http] annotations.
|
Package httprule provides a parser for the path templates found in [google.api.http] annotations. |
|
sidekick/parser/svcconfig
Package svcconfig contains helper functions to parse service config files.
|
Package svcconfig contains helper functions to parse service config files. |
|
sidekick/protobuf
Package protobuf provides utilities for handling protobuf files.
|
Package protobuf provides utilities for handling protobuf files. |
|
sidekick/rust
Package rust implements a native Rust code generator.
|
Package rust implements a native Rust code generator. |
|
sidekick/rust_prost
Package rust_prost implements a Rust code generator using the prost toolchain.
|
Package rust_prost implements a Rust code generator using the prost toolchain. |
|
sidekick/source
Package source provides functionalities to fetch and process source for generating and releasing clients in all languages.
|
Package source provides functionalities to fetch and process source for generating and releasing clients in all languages. |
|
snippetmetadata
Package snippetmetadata provides cross-language functionality for working with metadata files associated with generated sample code.
|
Package snippetmetadata provides cross-language functionality for working with metadata files associated with generated sample code. |
|
surfer/gcloud
Package gcloud generates gcloud command YAML files.
|
Package gcloud generates gcloud command YAML files. |
|
surfer/gcloud/utils
Package utils provides utility functions for the gcloud generator.
|
Package utils provides utility functions for the gcloud generator. |
|
surfer/surfer
Package surfer provides the core implementation for the surfer CLI tool.
|
Package surfer provides the core implementation for the surfer CLI tool. |
|
testhelper
Package testhelper provides helper functions for tests.
|
Package testhelper provides helper functions for tests. |
|
yaml
Package yaml provides generic YAML read and write operations.
|
Package yaml provides generic YAML read and write operations. |
|
tool
|
|
|
cmd/importconfigs
command
import configs is a tool to import configs from googleapis into api.go intended to be a temp tool during migration
|
import configs is a tool to import configs from googleapis into api.go intended to be a temp tool during migration |
|
cmd/migrate
command
Command migrate is a tool for migrating .sidekick.toml or .librarian configuration to librarian.yaml.
|
Command migrate is a tool for migrating .sidekick.toml or .librarian configuration to librarian.yaml. |
Click to show internal directories.
Click to hide internal directories.