server

package

v0.0.0-...-d0dead0 Latest Latest Go to latest Published: Nov 2, 2020 License: MIT Imports: 7 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This module is one of the most important as it allows to directly interact with CBM's server

This section will give a brief overview of each command's capabilities. For more informations, please see [] ⚠ TODO: add link to details

These two commands are pretty self explanatory, so here's a quick exemple of both:

    cbm server start
    cbm server stop

These two commands allow you to respectively drop or add a repository to CBM's watch-list.

    cbm server add 'path/to/repository'
    cbm server drop 'repository-name'

This command will list some information's what CBM's server.

By default, if no arguments are provided, it will display CBM's watch-list (and is currently this only behavior of this command).

    cbm server list

View Source

const (
	OFF         = false
	ON          = true
	BackendDir  = ".cbm/backend/"
	EnvFileName = ".env"
	LocalUrl    = "http://127.0.0.1"
)

View Source

var Port = ""

View Source

var State = OFF

func Add(repoName string)

Add: Check server state and Prepare repository path before calling addNewProject

func Drop(repo string)

Drop: Get Repo information and send request to API in order to remove it from API.

func GetApiUrl(urlSuffix string) string

func GetBackendGlobalDirectory() (string, bool)

GetBackendGlobalDirectory: Search global cbm install dir with env.

func GetServerState() bool

GetServerState: Check if Cbm-api is running with port in global CBM install

func List()

List: Request API to list currently watched repository.

func Start()

func Stop()

This section is empty.