@remote.it/virtual-devices

    0.2.0 • Public • Published

    @remote.it/virtual-devices

    NPM version NPM downloads

    The purpose of this project is to be able to test remote.it products and features with virtual devices. These virtual device are created from Docker containers with Alpine Linux base images and connectd installed. Enabled services include SSH and HTTP.

    Guides

    Installation

    npm install -g @remote.it/virtual-devices

    Usage

    Create

    Bulk ID: Corresponds to the product bulk identification code.

    CSV Path: The path to the bulk registeration CSV file.

    $: virtual-devices create BULK_ID BULK_REG_CSV_PATH
    $: virtual-devices create 4F389758-2FEC-51AE-EB8A-82B5EAD9XYXY ./test_csv_files/500_devices.csv

    Stop

    Stops all running virtual device containers.

    $: virtual-devices stop

    Delete

    Deletes all running virtual device containers.

    $: virtual-devices delete

    Start

    Starts all stopped virtual device containers.

    $: virtual-devices start

    Exec

    Executes an argued shell command inside every running container.

    $: virtual-devices exec "touch test.txt"

    Help

    $: virtual-devices --help
    
      Usage: virtual-devices [options] [command]
    
      The purpose of this project is to be able to test remote.it products and features with virtual devices. These virtual device are created from Docker containers with Alpine Linux base images and Connectd installed.
    
      Options:
    
        -V, --version  output the version number
        -h, --help     output usage information
    
      Commands:
    
        create         Parses a bulk reg file and creates virtual devices containers. EX: virtual-devices create BULKD_ID CSV_PATH
        stop           Stops all running virtual device containers. EX: virtual-devices stop
        delete         Deletes all running virtual device containers. EX: virtual-devices delete
        start          Starts all stopped virtual device containers. EX: virtual-devices start
        exec           Executes an argued shell command inside every running container. EX: virtual-devices exec "COMMAND"
    

    Compatibility

    This package uses Unix commands to determine which Docker containers are virtual-devices. This causes the tool to have limited availability on non-Unix based operating systems such as Windows. The only command that works on Windows is virtual-devices create.

    License

    MIT

    Install

    npm i @remote.it/virtual-devices

    DownloadsWeekly Downloads

    1

    Version

    0.2.0

    License

    MIT

    Unpacked Size

    2.05 MB

    Total Files

    38

    Last publish

    Collaborators

    • penngrove
    • jamieruderman
    • remotebstrech
    • ebowers