module Build

Overview

This command is used to login to the Build API. The Build API token is stored in the user's netrc file. Because the commandline needs the token, it does a three-way OAuth authentication. This command requests a login authorization from Build, then opens a browser to have the users OAuth-accept that authorization. Once the user accepts the authorization, the command polls the Build API to get the user's token.

Defined in:

lib/build-client/src/build-client.cr
lib/build-client/src/build-client/api/addon_attachments_api.cr
lib/build-client/src/build-client/api/addon_services_api.cr
lib/build-client/src/build-client/api/addons_api.cr
lib/build-client/src/build-client/api/buildpacks_api.cr
lib/build-client/src/build-client/api/collaborators_api.cr
lib/build-client/src/build-client/api/default_api.cr
lib/build-client/src/build-client/api/domains_api.cr
lib/build-client/src/build-client/api/formation_api.cr
lib/build-client/src/build-client/api/pipeline_promotions_api.cr
lib/build-client/src/build-client/api/pipelines_api.cr
lib/build-client/src/build-client/api_client.cr
lib/build-client/src/build-client/api_error.cr
lib/build-client/src/build-client/configuration.cr
lib/build-client/src/build-client/models/addon.cr
lib/build-client/src/build-client/models/addon_app.cr
lib/build-client/src/build-client/models/addon_attachment.cr
lib/build-client/src/build-client/models/addon_billed_price.cr
lib/build-client/src/build-client/models/addon_info_attachment.cr
lib/build-client/src/build-client/models/addon_plan.cr
lib/build-client/src/build-client/models/addon_plan_catalog_item.cr
lib/build-client/src/build-client/models/addon_plan_price.cr
lib/build-client/src/build-client/models/addon_service.cr
lib/build-client/src/build-client/models/addon_service_catalog_item.cr
lib/build-client/src/build-client/models/addon_service_category.cr
lib/build-client/src/build-client/models/addon_with_attachments.cr
lib/build-client/src/build-client/models/app.cr
lib/build-client/src/build-client/models/app_buildpack.cr
lib/build-client/src/build-client/models/app_formation_value.cr
lib/build-client/src/build-client/models/app_me_response.cr
lib/build-client/src/build-client/models/app_pipeline.cr
lib/build-client/src/build-client/models/app_team.cr
lib/build-client/src/build-client/models/attachment_addon.cr
lib/build-client/src/build-client/models/build.cr
lib/build-client/src/build-client/models/build_buildpacks_inner.cr
lib/build-client/src/build-client/models/build_slug.cr
lib/build-client/src/build-client/models/build_source_blob.cr
lib/build-client/src/build-client/models/build_user.cr
lib/build-client/src/build-client/models/buildpack_installation.cr
lib/build-client/src/build-client/models/buildpack_installation_buildpack.cr
lib/build-client/src/build-client/models/collaborator.cr
lib/build-client/src/build-client/models/collaborator_app.cr
lib/build-client/src/build-client/models/collaborator_user.cr
lib/build-client/src/build-client/models/create_addon_attachment_request.cr
lib/build-client/src/build-client/models/create_addon_request.cr
lib/build-client/src/build-client/models/create_app_request.cr
lib/build-client/src/build-client/models/create_domain_request.cr
lib/build-client/src/build-client/models/create_namespace410_response.cr
lib/build-client/src/build-client/models/create_namespace_request.cr
lib/build-client/src/build-client/models/create_pipeline_promotion_request.cr
lib/build-client/src/build-client/models/create_pipeline_promotion_request_source.cr
lib/build-client/src/build-client/models/create_pipeline_promotion_request_targets_inner.cr
lib/build-client/src/build-client/models/deployment.cr
lib/build-client/src/build-client/models/deployment_build.cr
lib/build-client/src/build-client/models/domain.cr
lib/build-client/src/build-client/models/domain_app.cr
lib/build-client/src/build-client/models/domain_sni_endpoint.cr
lib/build-client/src/build-client/models/dyno.cr
lib/build-client/src/build-client/models/dyno_exec_request.cr
lib/build-client/src/build-client/models/dyno_exec_response.cr
lib/build-client/src/build-client/models/dyno_run_request.cr
lib/build-client/src/build-client/models/dyno_run_response.cr
lib/build-client/src/build-client/models/error_response.cr
lib/build-client/src/build-client/models/exec_output.cr
lib/build-client/src/build-client/models/formation_batch_update_request.cr
lib/build-client/src/build-client/models/formation_update.cr
lib/build-client/src/build-client/models/get_pipeline_diff200_response.cr
lib/build-client/src/build-client/models/get_pipeline_diff200_response_diffs_inner.cr
lib/build-client/src/build-client/models/get_pipeline_diff200_response_diffs_inner_commits_inner.cr
lib/build-client/src/build-client/models/get_pipeline_diff200_response_source.cr
lib/build-client/src/build-client/models/me_app.cr
lib/build-client/src/build-client/models/namespace.cr
lib/build-client/src/build-client/models/namespace_actor.cr
lib/build-client/src/build-client/models/namespace_team.cr
lib/build-client/src/build-client/models/oidc_login_response.cr
lib/build-client/src/build-client/models/oidc_login_response_spec.cr
lib/build-client/src/build-client/models/oidc_login_response_status.cr
lib/build-client/src/build-client/models/pipeline.cr
lib/build-client/src/build-client/models/pipeline_environments_inner.cr
lib/build-client/src/build-client/models/pipeline_promotion.cr
lib/build-client/src/build-client/models/pipeline_team.cr
lib/build-client/src/build-client/models/process.cr
lib/build-client/src/build-client/models/promotion_pipeline.cr
lib/build-client/src/build-client/models/promotion_source.cr
lib/build-client/src/build-client/models/promotion_source_app.cr
lib/build-client/src/build-client/models/promotion_target.cr
lib/build-client/src/build-client/models/promotion_target_app.cr
lib/build-client/src/build-client/models/promotion_target_promotion.cr
lib/build-client/src/build-client/models/team.cr
lib/build-client/src/build-client/models/update_app_request.cr
lib/build-client/src/build-client/models/update_buildpacks_request.cr
lib/build-client/src/build-client/models/update_buildpacks_request_updates_inner.cr
lib/build-client/src/build-client/models/update_domain_request.cr
lib/build-client/src/build-client/models/validation_errors.cr
build_cli.cr
commands/addons.cr
commands/app.cr
commands/base.cr
commands/buildpacks.cr
commands/builds.cr
commands/config.cr
commands/deployments.cr
commands/domains.cr
commands/help.cr
commands/login.cr
commands/logs.cr
commands/namespaces.cr
commands/oidc_login.cr
commands/pipelines.cr
commands/ps.cr
commands/run.cr
commands/skills.cr
commands/team.cr
commands/whoami.cr
console/localized_text_descriptor.cr
display_width.cr
env_format.cr
ext/build_client_accept_language.cr
i18n.cr
log_colorizer.cr
update_check.cr

Constant Summary

ACON_MARKUP = /<\/?[^>]*>/

ANSI_ESCAPE = /\e\[[0-?]*[ -\/]*[@-~]/

SLOW_REQUEST_AFTER = 5.seconds

A request that has run this long gets one line on stderr saying so, when a person is watching (stderr is a TTY) and -q was not given.

Class Method Summary

• .api_host
• .api_host_scheme
• .api_url
• .char_display_width(char : Char) : Int32
• .debugging?

  Controls both CLI debug messages and SDK request logging: DEBUG=1 or -vvv.

• .display_width(value : String) : Int32
• .git_host
• .ljust_display(value : String, width : Int32) : String
• .parsed_api_uri
• .quiet?
• .setup_global_api_config

  Method to setup global API client config

• .t(message_key : String | Symbol, params : Hash | NamedTuple | Nil = nil) : String
• .t(message_key : String | Symbol, **kwargs) : String

Class Method Detail