lando : object

This is the high level object that contains the Lando libraries.

Kind: global namespace
Since: 3.0.0
Example

// Get lando
var lando = require('./lando')(globalConfig);

// Add an item to the cache
lando.cache.set('mykey', data);

// Start an app
return lando.app.start(app);

// Check to see if a docker container is running
return lando.engine.isRunning({id: 'myapps_httpd_1'});

// Log an error
lando.log.error('Ive got a baaaad feeling about this');

// Access a global config property
var plugins = lando.config.plugins;

// Emit an event
return lando.events.emit('battle-of-yavin', fleetOpts);

// Run a function when an event is triggered
return lando.events.on('battle-of-yavin', stayOnTarget);

// Get the lodash module for our plugin
var _ = lando.node._;

// Retry a function with a Promise.
return lando.Promise.retry(lando.engine.start(container)));

// Load a plugin
return lando.plugins.load('hyperdrive');

// Remove an app from the registry
return lando.registry.remove({app: name, dir: dir});

// Execute a command
return lando.shell.sh(['docker', 'info']);

// Add a new task to Lando
lando.tasks.add('fireeverything', task);

lando.app

The app module.

Contains helpful methods to manipulate Lando apps.

Kind: static property of lando
See: app.md
Since: 3.0.0

lando.bootstrap

The bootstrap module.

Contains helpful methods to bootstrap Lando.

Kind: static property of lando
See: bootstrap.md
Since: 3.0.0

lando.cache

The cache module.

Contains helpful methods to cache data.

Kind: static property of lando
See: cache.md
Since: 3.0.0

lando.cli

The cli module.

Contains helpful methods to init a CLI, inject commands and display CLI data.

Kind: static property of lando
See: cli.md
Since: 3.0.0

lando.config

The global config object

Kind: static property of lando
See: config.md
Since: 3.0.0

lando.engine

The engine module.

Contains helpful methods to manipulate the docker daemon, engine, its containers, volumes and networks.

Kind: static property of lando
See: engine.md
Since: 3.0.0

lando.error

The error module.

Contains helpful error handling methods.

Kind: static property of lando
See: error.md
Since: 3.0.0

lando.events

The events module.

An instance of AsyncEvents.

Kind: static property of lando
See: events.md
Since: 3.0.0

lando.log

The logging module.

Contains logging methods.

Kind: static property of lando
See: log.md
Since: 3.0.0

lando.networks

The networks module.

Contains ways to interact with docker networks.

Kind: static property of lando
See: networks.md
Since: 3.0.0

lando.node

The node module.

Contains helpful node modules like lodash and restler that can be used in plugins.

Kind: static property of lando
See: node.md
Since: 3.0.0

lando.plugins

The plugins module.

Contains helpful methods to load Lando plugins.

Kind: static property of lando
See: plugins.md
Since: 3.0.0

lando.Promise

The Promise module.

An extended bluebird Promise object.

Kind: static property of lando
See: promise.md
Since: 3.0.0

lando.registry

The registry module.

Contains helpful methods to interact with the appRegistry.

Kind: static property of lando
See: registry.md
Since: 3.0.0

lando.shell

The shell module.

Contains helpful methods to parse and execute commands.

Kind: static property of lando
See: shell.md
Since: 3.0.0

lando.tasks

The tasks module.

Contains helpful methods to define and parse Lando tasks.

Kind: static property of lando
See: tasks.md
Since: 3.0.0

lando.update

The update module.

Contains warnings and help if update is needed

Kind: static property of lando
See: update.md
Since: 3.0.0

lando.user

The user module.

Contains helpful methods to get information about user running Lando.

Kind: static property of lando
See: user.md
Since: 3.0.0

lando.utils

The utils module.

Contains helpful utility methods.

Kind: static property of lando
See: utils.md
Since: 3.0.0

lando.yaml

The yaml module.

Contains helpful yaml methods.

Kind: static property of lando
See: yaml.md
Since: 3.0.0

results matching ""

    No results matching ""