npm package: @jimmyhmiller/manta
Description: Manta Client API
Author: Joyent
Latest version: 5.2.4

# Manta Client Tools and SDK

[manta](http://apidocs.joyent.com/manta/nodesdk.html) is a Node.js SDK for
interacting with Joyent's Manta system.

This repository is part of the Joyent [Manta](http://github.com/joyent/manta)
project.  See [CONTRIBUTING.md](CONTRIBUTING.md) for contribution guidelines.

# Installation

[Node.js](https://nodejs.org/) must be installed.

## Command line utilities

### Install Globally

To install globally (to use the CLI tools) you can try running:

    $ npm install -g manta

Note that this might require `sudo` or escalated privileges to install
properly.  This can often result in permissions errors or other failures - in
that case try the below method.

### Install Globally to a User Directory

Based on the [npm guide to prevent permissions
errors](https://docs.npmjs.com/getting-started/fixing-npm-permissions#option-two-change-npms-default-directory),
this module can be installed locally to a hidden path in your home directory as
a global package by modifying the prefix that `npm` uses:

    mkdir -p ~/.npm-global
    npm config set prefix '~/.npm-global'
    npm install -g manta
    export PATH=$PATH:~/.npm-global/bin
    export MANPATH=$MANPATH:~/.npm-global/share/man

You can persist this `PATH` by adding the following line to your `~/.bashrc`
file or similar:

``` bash
export PATH=$PATH:~/.npm-global/bin
export MANPATH=$MANPATH:~/.npm-global/share/man
```

## Node.js module

To install locally as a module (to use the SDK).

    $ npm install manta

### Bash completion

Optionally install Bash completion. This is done by `source`ing the
`share/manta.completion` file that is installed with the tools.

``` bash
source "$(npm prefix -g)/lib/node_modules/manta/share/manta.completion"
```

Put that (or the equivalent) in your `~/.bashrc` file to make it permanent.

You can verify that completions are working by typing the `TAB` key with
the following:

    $ mls --<TAB>
    --account   --insecure  --long      --role      --type      --verbose
    --fulljson  --json      --marker    --subuser   --url       --version
    --help      --keyId     --reverse   --time      --user

# Usage

First setup your environment to match your Joyent Manta account:

    $ export MANTA_KEY_ID=$(ssh-keygen -l -f ~/.ssh/id_rsa.pub | awk '{print $2}')
    $ export MANTA_URL=https://us-east.manta.joyent.com
    $ export MANTA_USER=mark

Alternatively, you can pull your ssh key out of your `ssh-agent` if you are
using one (this snippet takes the first key in the agent).

    $ export MANTA_KEY_ID=$(ssh-add -l | awk '{print $2}' | head -1)

## SDK

Then a code snippet:

``` js
var assert = require('assert');
var fs = require('fs');
var manta = require('manta');

var client = manta.createClient({
    sign: manta.privateKeySigner({
        key: fs.readFileSync(process.env.HOME + '/.ssh/id_rsa', 'utf8'),
        keyId: process.env.MANTA_KEY_ID,
        user: process.env.MANTA_USER
    }),
    user: process.env.MANTA_USER,
    url: process.env.MANTA_URL
});
console.log('manta ready: %s', client.toString());

client.get('/mark/stor/foo', function (err, stream) {
    assert.ifError(err);

    stream.setEncoding('utf8');
    stream.on('data', function (chunk) {
        console.log(chunk);
    });
});
```

If your paths begin with `'~~/'` then manta will automatically fill in the
current manta user, which helps you write more generic code since you get rid
of the hardcoded user name. The following two rows are identical:

``` js
client.get('/mark/stor/foo', function (err, stream) {});
client.get('~~/stor/foo', function (err, stream) {});
```

## CLI

Basic commands include:

1. `mls` - lists directory contents, default /:user/stor
2. `mmkdir` - create a directory
3. `mput` - uploads data to a Manta object
4. `mget` - downloads an object from Manta
5. `mjob` - creates and runs a computational job on Manta
6. `mfind` - walks a Manta hierarchy to find names of objects by name, size, or type

A full set of commands for interacting with Manta is in `bin`.

# More documentation

Docs can be found here:
[http://apidocs.joyent.com/manta/](http://apidocs.joyent.com/manta/)


# Testing

Running this test suite will create files in Manta (using your current
`MANTA_*` environment variables).

    make test

The set of test files run can be filtered:

    make test TEST_FILTER=muntar

As well, you can get debug/trace logging (note that we intentionally avoid
`LOG_LEVEL` because the `m*` tools use that and sharing the same envvar can
break tests):

    make test TEST_LOG_LEVEL=trace 2>&1 | bunyan


There is a mechanism to re-build and test with a number of installed node
versions. First you must create "test/node.paths" (based on
"test/node.paths.example") and then:

    make testall


# License

```
The MIT License (MIT)

Copyright (c) 2018, Joyent, Inc.

Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
```

# Bugs

See https://github.com/joyent/node-manta/issues.

# Release process

Here is how to cut a release:

1. Make a commit to set the intended version in "package.json#version" and
   changing `## not yet released` at the top of "CHANGES.md" to:

    ```
    ## not yet released


    ## $version
    ```

2. Get that commit approved and merged via <https://cr.joyent.us>, as with all
   commits to this repo. See the discussion of contribution at the top of this
   readme.

3. Once that is merged and you've updated your local copy, run:

    ```
    make cutarelease
    ```

   This will run a couple checks (clean working copy, versions in package.json
   and CHANGES.md match), then will git tag and npm publish.

# Supported Node.js Versions

Currently, node-manta is officially supported on the following node versions:

* v0.10 (latest tested 0.10.48)
* v0.12 (latest tested 0.12.18)
* v4.8 (latest tested 4.8.4)
* v6.11 (latest tested 6.11.2)
* v8.3 (latest tested 8.3.0)