package b0

You can search for identifiers within the package.

in-package search v0.2.0

Software construction and deployment kit

Install

Dune Dependency

erratique.ch Readme Changelog ISC; BSD-2-Clause License Edit opam file Versions (6)

Authors

T

The b0 programmers

Maintainers

Daniel Bünzli

Sources

b0-0.0.2.tbz

sha512=78fd9e53b84cf5d6bf497adaf4b6d7d974134044318639cdfe5e01c7faaa8d987d04769abe3b3b1cbdb937132e21d8723dc185cd3c68433a793278907a8e757e

doc/b0_b00_kit/B00_github/Auth/index.html

Module `B00_github.Auth`

type t

The type for GitHub authentication.

val v : user:string option -> unit -> (t, string) Stdlib.result

auth ~http ~user () determines authentication via personal access token for user user. It the latter is unspecified it first starts by determining user by looking the

It first looks up the contents of the B0_GITHUB_TOKEN environment variable if that fails it looks up for an existing token in the B00_std.Os.Dir.config () /b0/github/$USER.token file. If that fails instructions are printed on how to setup the token.

val user : t -> string

user a is the GitHub user.

val token : t -> string

token a is the Github token.

Command line interface

val user_env : string

user_env is "B0_GITHUB_USER".

val token_env : string

user_env is "B0_GITHUB_TOKEN".

val envs : Cmdliner.Arg.env list

envs describe user_env and token_env.

val cli : 
  ?opts:string list ->
  unit ->
  (t, string) Stdlib.result Cmdliner.Term.t

cli () is a command line interface for GitHub authentication. opts are the options that can be used for specifiying the github user (defaults to ["u";"github"])

On This Page

Command line interface