https://github.com/julienvincent/ambient-cli

CLI tool
https://github.com/julienvincent/ambient-cli

Last synced: about 2 months ago
JSON representation

CLI tool

• Host: GitHub
• URL: https://github.com/julienvincent/ambient-cli
• Owner: julienvincent
• Created: 2016-02-09T10:47:05.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2016-06-01T15:16:46.000Z (over 8 years ago)
• Last Synced: 2024-09-27T09:14:20.000Z (3 months ago)
• Language: JavaScript
• Size: 78.1 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

        
# ambient-cli

Cli tool for interacting with development environments from anywhere.

##### Why does this exist?

Lazyness. Pure and simple.

##### What does it solve?

`$ cd /some/dir`

===

On a more serious note - I wrote this cli to speed up local development a little bit. It allows you to start servers or scripts and run commands

on a directory from wherever you are without having to navigate to the location of the project. This is especially useful if you are working on project 

that is split up among a few directories. Yep - that's it

## Installation and Usage

`npm i -g ambient-cli`

```

$ ambient add my-project

$ Added environment my-project

$ ambient start my-project

$ Starting server...

...

^C

$ ambient start my-project --daemon

$ Starting server...

$ 

```

#### Command list

```

Cli tool for interacting with development environments from anywhere.

Usage:

ambient [command] --flags

Available commands:

  - add      Add an ambient environment to list of know environments

  - remove   Remove an environment from ambients known environments

  - update   Update an environment

  - list|ls  List all known environments

  - use      Specify a default environment

  - start    Start a server

  - stop     Stop ambient servers

  - restart  Restart ambient servers

  - run      Run a command on an environments root relative root. -b, --base to run at projects real base

  - install  Install a package using npm [or --jspm]

  - logs     Display logs for a given process

Available flags:

 -a, --alias        Set an alias name for the environment

 -u, --use          Set this environment as default.

 -f, --force        Force an action to happen. Commonly used to overwrite an existing environment

 --name             Specify a new name when updating an environment

 --dir              Explicitly set the root directory of an environment when adding or updating it

 -l, --logs         Directory to store logs when running processes

 -R, --reuse        Reuse an old process (including its runtime options and arguments)

 -b, --base         Reference an environments base

 -i, --interactive  Run a command in interactive mode

 -t, --timeout      Set a timeout for operations

 --running          Filter by environments' running status

 -d, --daemon       Start a server as a daemon

 --no-parse         When listing running environments, display a direct listing of running processes

 --no-save          Install a module without saving it

```

## Specifying custom runtime settings.

ambient-cli will look for a `.ambient` file in your projects root. In this file you can configure how ambient must run your project

```javascript

{

  "command": "node", // The service to run your script with. Defaults to node

  "script": "core/server.js", // The location of your script relative to root

  "root": "src", // The root of your project. Set it to the directory of your node_modules if using node.

  "args": ["--production"], // additional arguments to run with the script

  "logs": "logs", // custom location for logs. defaults to ~/.ambient/logs

  

  // You can also predefine commands. These commands can be run using `ambient run build` or `ambient run start`

  "commands": {

    "build": {

        "plainCommand": "npm run build",

        "root": "src"

    },

    

    "start": {

        "command": "node",

        "script": "core/server.js",

        "root": "src"

    }

  }

}

```

If you want `ambient list` to keep track of running environments that are container based, then do not run them as daemons. eg:

```javascript

{

  "command": "docker-compose up container", // instead of `docker-compose up -d container`

}

```

If no `.ambient` file is found, the cli will look for a `package.json` in either your projects root or in a `src` sub directory. It will then run the script at `main` using node.