Skip to content

jopemachine-arvis/arvis-store

Repository files navigation

arvis-store

CodeFactor Known Vulnerabilities CI NPM version MIT license PR's Welcome GitHub issues

Publish and Retrieve Arvis extension info

Check on docs

Usage - cli

view

To view some extension info on cli, run below command.

$ arvis-store view [some_extension_name]

set github token

To publish arvis extension to store, need to set github api token first.

Gey your github access token in here and,

Run below command to set your github api token.

$ arvis-store set-gh-api-key [github_api_key]

publish

To publish current extension directory to arvis-store, run below command.

If the extension in uploaded on npm, run

$ arvis-store publish --npm

Otherwise, run below command.

Below command upload an arvisworkflow file or an arvisplugin file to the arvis-store github repository.

Users can download the file from the store and use it.

$ arvis-store publish --local

download

To download local extension file,

$ arvis-store download workflow [creator_name] [extension_name]
$ arvis-store download plugin [creator_name] [extension_name]

unpublish

To unpublish extension from store, run

$ arvis-store unpublish [creator_name] [extension_name]

How to add arvis-extension to arvis-store

  1. Install arvis-store
$ npm i -g arvis-store
  1. Set Github personal access token
$ arvis-store set [github_personal_access_token]
  1. Run publish command

If the extension in uploaded on npm,

Run

$ arvis-store publish --npm

Otherwise, Run

$ arvis-store publish --local

How it works

  1. The store is internal/store.json file. and it is renewed once a day, and every time a new extension is added to the store by github-workflows

  2. internal/store.json stores information that always requires renewal like npm download info, it's latest version.

  3. internal/statis-store.json's information updates only when extensions are created or need to be changed by the extension creator

  4. arvis-store publish command creates a PR that adds your extension to the internal/static-store.json.

Related

  • arvish - Arvis workflow, plugin creator tools

About

Publish and Retrieve Arvis extension info

Topics

Resources

License

Stars

Watchers

Forks

Contributors 4

  •  
  •  
  •  
  •