npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@signageos/cli

v1.4.1

Published

signageOS command-line interface which helps you develop your applets locally and manage devices from terminal.

Downloads

306

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

misak113misak113kytartkytartpetrbilypetrbilysignageos.iosignageos.io

Keywords

Readme

CLI program

signageOS command-line interface which helps you develop your applets locally and manage devices from terminal.

Usage

npm install @signageos/cli -g
sos --help

User Interface

cli tool allows you to run commands interactively for best user experience, please use standard bash terminal on *nix systems and gitbash, run it in windows terminal.

Test

cp .env.amy .env
# Unit tests
npm test
# Integration tests (against AMY environment)
npm run test-integration

API reference

General

| Argument | Description | Default value | |----------------------------|---------------------------------|---------------------------------------------------| | --api-url (optional) | URL address to use for REST API | ${SOS_API_URL~'https://api.signageos.io'} | | --profile (optional) | Profile used for separation of credentials and other configurations set in the ~/.sosrc file | ${SOS_PROFILE} |

Login

Requirements

sos login
  • Login account to allow use REST API commands
  • Logged account credentials are stored in ~/.sosrc file.
  • You override login credentials using environment variables SOS_API_IDENTIFICATION & SOS_API_SECURITY_TOKEN. Go to https://box.signageos.io/settings to generate the token.

| Argument | Description | Default value | |----------------------------|---------------------------------|----------------| | --username (required) | Username or e-mail user for box | STDIN |

Run control file

There are file created when run command sos login in the path ~/.sosrc. This file contains by default only following values (as default profile is used).

identification=xxxxxxxxxxxxxxxxxxxx
apiSecurityToken=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

If you'd like to manage more accounts/configurations on one machine, you can use environment variable SOS_PROFILE or argument --profile. The configuration file will uses a INI section profile xxxx for the profile named xxxx. You can use as many profiles as you want.

[profile xxxx]
identification=xxxxxxxxxxxxxxxxxxxx
apiSecurityToken=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Applet

sos applet --help

Applet Generation

sos applet generate --name my-sample-applet --language=typescript
cd my-sample-applet
# Develop your applet with watching changes
npm start
# Build your applet production environment
npm run build

| Argument | Description | Default value | |------------------------------|--------------------------------------|----------------| | --name (required) | Name your applet | STDIN | | --version (optional) | Initial version | 0.0.0 | | --target-dir (optional) | Generate applet project to directory | ${PWD}/${name} | | --npm-registry (optional) | NPM registry URL (for private npm) | | | --language (optional) | Generate applet with "typescript" or "javascript" source code | STDIN |

! Windows users note: There are unresolved issue with NPX tool on Windows clients when your username contains spaces (e.g.: John Doe). https://stackoverflow.com/a/58354623/4609457 To prevent this issue there is simple hotfix. Run following command in your Command Line (replace John with your real first name): Sometimes the Administrator privileges are required (Run as Administrator)

npm config set cache "C:\Users\John~1\AppData\Roaming\npm-cache" --global

Applet Upload

npm run upload
# Uploads all files in the applet directory
# Or alternatively you can use direct cli: `sos applet upload`

#Deprecated
sos applet upload --applet-path=dist/index.html
# This will upload only the one specified file
# Rest of the files will be removed from our servers
  • If applet is not created yet, it will create it
  • The applet version is used from package.json
  • Applet UID will be stored in package.json sos.appletUid
  • You can use SOS_APPLET_UID as environment variable to specify appletUid to upload to (sos.appletUid of package.json will be overlooked).
  • You can use SOS_APPLET_VERSION as environment variable to specify applet version to upload to (version of package.json will be overlooked).
  • Ignore files priority (from top to bottom) .sosignore > .npmignore > .gitignore
  • Only one ignore file is used or non

| Argument | Description | Default value | |--------------------------------|-------------------------------|------------------------| | --applet-path (optional) | Path of project directory | ${PWD} | | --entry-file-path (optional) | Path of applet entry file | ${PWD}/dist/index.html |

Applet Build

sos applet build
# Build applet locally. The result is a zip file in the /tmp/signageos directory.

| Argument | Description | Default value | |--------------------------------|-------------------------------|------------------------| | --applet-uid (required) | Applet UID | STDIN | | --organization-uid (required) | Organization UID | STDIN |

Applet Start

sos applet start
  • It's meant to be used with applets not created using the cli
  • Default values work for applet created using the cli

| Argument | Description | Default value | |--------------------------------|---------------------------------------|------------------------| | --organization-uid (required) | Organization UID | STDIN | | --port (optional) | Port where the applet will run | 8090 | | --applet-path (optional) | Root path of applet project | ${PWD}/dist | | --entry-file-path (optional) | Path of built applet entry file | ${PWD}/dist/index.html | | --server-public-url (optional) | Public url of local machine server. Is useful when the local machine is behind a reverse proxy. | http://{CURRENT_REMOTE_ADDR}:{RANDOM_PORT} | | --server-port (optional) | The custom server port for local machine server. | {RANDOM_PORT} | | --hot-reload (optional) | Enable hot reload and build of applet | false | | --force (optional) | Force start applet server of hot reload even if it is already running on a different port. Kill the running server first. | false |

Applet Tests Upload

sos applet test upload
  • Upload all test files specified in package.json in sos.tests. The property is array of strings (relative paths to test files). E.g.: ["tests/sample.spec.js", "tests/sample2.spec.js"]
  • It removes files which are extra on server already

| Argument | Description | Default value | |--------------------------------|-----------------------------------------------|------------------------| | --yes (optional) | Skip interactive mode before it's uploaded | false | | --verbose (optional) | Show detailed info about changed files | false |

Applet Tests Run

sos applet test run
  • Run test files uploaded to server remotely.

| Argument | Description | Default value | |--------------------------------|--------------------------------------------------------------|------------------------| | --yes (optional) | Skip interactive mode before it's uploaded | false | | --test (optional) | Test files which should be run. If omitted, all test are run | {all tests} |

Organization

sos organization --help

Organization List

  • Output is printed to STDOUT as JSON
sos organization list

Organization Get

  • Output is printed to STDOUT as JSON
sos organization get

| Argument | Description | Default value | |---------------------------------|------------------------------|----------------| | --organization-uid (required) | Organization UID | STDIN |

Organization Set Default

  • Sets default organization for current logged in account. This organization will be used for example in webpack plugin of applet to register emulator
  • If you not set default organization, by default will be used the organization you will be asked to select from list where you have access to.
sos organization set-default
  • You override default organization using environment variable SOS_ORGANIZATION_UID. Go to https://box.signageos.io/organizations to git the organizationUid.

| Argument | Description | Default value | |---------------------------------|------------------------------|----------------| | --organization-uid (required) | Organization UID | STDIN |

Timing

sos timing --help

Timing List

  • Output is printed to STDOUT as JSON
sos timing list

| Argument | Description | Default value | |---------------------------------|------------------------------|----------------| | --organization-uid (required) | Organization UID | STDIN | | --device-uid (required) | Device UID | STDIN |

Device

sos device --help

Device Power action

Perform specified power action on a device.

sos device power-action

| Argument | Description | Default value | |---------------------------------|------------------------------|----------------| | --organization-uid (required) | Organization UID | STDIN | | --device-uid (required) | Device UID | STDIN | | --type (required) | Type of power-action | STDIN |

Device Power action types

| Argument | Description | |---------------------------------|------------------------------| | reload | Applet Reload | | displayOn | Display power On | | displayOff | Display power Of | | restart | Application restart | | disable | Applet disable | | enable | Applet enable | | reboot | System reboot | | refresh | Applet Refresh |

Device Set-Content

sos device set-content

| Argument | Description | Default value | |---------------------------------|------------------------------|----------------| | --organization-uid (required) | Organization UID | STDIN | | --device-uid (required) | Device UID | STDIN | | --applet-uid (required) | Applet UID | STDIN |

Device connect

sos device connect
# You will be provided with setting parameters
# You should build and upload applet to box before connecting applet to device 
# The applet has to be at least uploaded once with the specific version

| Argument | Description | Default value | |--------------------------------|---------------------------------------|------------------------| | --device-uid (required) | Uid of device from box' | STDIN | | --applet-uid (required) | Applet UID | STDIN | | --organization-uid (required) | Organization UID | STDIN | | --update-package-config (optional) | Update package.json value sos.appletUid config when applet doesn't exists and is created | false | | --server-public-url (optional) | Public url of local machine server. Is useful when the local machine is behind a reverse proxy. | http://{CURRENT_REMOTE_ADDR}:{RANDOM_PORT} | | --server-port (optional) | The custom server port for local machine server. | {RANDOM_PORT} | | --force (optional) | Force start applet server even if it is already running on a different port. Kill the running server first. | false |

Contribution

Clone the repository and install dev dependencies

git clone [email protected]:signageos/cli.git # or https://github.com/signageos/cli.git
npm install

To try sos command directly from source code, use ts-node src/index.ts instead of sos in project directory.

Global requirements

npm install ts-node -g