Miss any of our Open RFC calls?Watch the recordings here! »

@aspen.cloud/aspen-cli

0.2.0 • Public • Published

Aspen CLI

Fetch and query all of your data from Gmail, Spotify, and more into a single database

  • Build your own sources/connections and publish on NPM
  • Query your data by source
  • Exchange queries via plugins

oclif Version Downloads/week License

Usage

$ npm install -g @aspen.cloud/aspen-cli
$ aspen COMMAND
running command...
$ aspen (-v|--version|version)
@aspen.cloud/aspen-cli/0.2.0 darwin-x64 node-v11.11.0
$ aspen --help [COMMAND]
USAGE
  $ aspen COMMAND
...

Roadmap

  • CLI access to AspenDB
  • Plugin support for different datasources
  • Spotify plugin
  • Query support with Mango Queries
  • Gmail plugin
  • Sync data to Aspen Cloud for multi-device support and web access
  • Auto-discovery schema for app
  • Add option to automatically build index for query
  • Google Takeout importer
  • Facebook download importer

Plugins

Commands

aspen help [COMMAND]

display help for aspen

USAGE
  $ aspen help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

aspen index INDEX

Index data in AspenDB

USAGE
  $ aspen index INDEX

OPTIONS
  -a, --app=app  (required) ID of the app to query
  -h, --help     show CLI help

EXAMPLE
  $ aspen index --app spotify '{"fields": ["type"]}'
  [all docs in the app spotify]

See code: src/commands/index/index.ts

aspen info [QUERY]

Get info about your installation

USAGE
  $ aspen info [QUERY]

OPTIONS
  -h, --help  show CLI help

See code: src/commands/info.ts

aspen plugins

list installed plugins

USAGE
  $ aspen plugins

OPTIONS
  --core  show core plugins

EXAMPLE
  $ aspen plugins

See code: @oclif/plugin-plugins

aspen plugins:install PLUGIN...

installs a plugin into the CLI

USAGE
  $ aspen plugins:install PLUGIN...

ARGUMENTS
  PLUGIN  plugin to install

OPTIONS
  -f, --force    yarn install with force flag
  -h, --help     show CLI help
  -v, --verbose

DESCRIPTION
  Can be installed from npm or a git url.

  Installation of a user-installed plugin will override a core plugin.

  e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command 
  will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in 
  the CLI without the need to patch and update the whole CLI.

ALIASES
  $ aspen plugins:add

EXAMPLES
  $ aspen plugins:install myplugin 
  $ aspen plugins:install https://github.com/someuser/someplugin
  $ aspen plugins:install someuser/someplugin

See code: @oclif/plugin-plugins

aspen plugins:link PLUGIN

links a plugin into the CLI for development

USAGE
  $ aspen plugins:link PLUGIN

ARGUMENTS
  PATH  [default: .] path to plugin

OPTIONS
  -h, --help     show CLI help
  -v, --verbose

DESCRIPTION
  Installation of a linked plugin will override a user-installed or core plugin.

  e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello' 
  command will override the user-installed or core plugin implementation. This is useful for development work.

EXAMPLE
  $ aspen plugins:link myplugin

See code: @oclif/plugin-plugins

aspen plugins:uninstall PLUGIN...

removes a plugin from the CLI

USAGE
  $ aspen plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

OPTIONS
  -h, --help     show CLI help
  -v, --verbose

ALIASES
  $ aspen plugins:unlink
  $ aspen plugins:remove

See code: @oclif/plugin-plugins

aspen plugins:update

update installed plugins

USAGE
  $ aspen plugins:update

OPTIONS
  -h, --help     show CLI help
  -v, --verbose

See code: @oclif/plugin-plugins

aspen query [QUERY]

Query data from AspenDB

USAGE
  $ aspen query [QUERY]

OPTIONS
  -a, --app=app      (required) ID of the app to query
  -h, --help         show CLI help
  -q, --query=query  Query your data with Mango syntax
  --full             Whether to include the full documents

EXAMPLE
  $ aspen query --app spotify
  [all docs in the app spotify]

See code: src/commands/query.ts

aspen source

Fetch and store data from external sources like Gmail, Spotify, etc.

USAGE
  $ aspen source

OPTIONS
  --preview

See code: src/commands/source/index.ts

aspen store [FILE]

Store JSON data from a file or stdin into an AspenDB

USAGE
  $ aspen store [FILE]

OPTIONS
  -a, --app=app  (required) id of the app to associate data with
  -h, --help     show CLI help

EXAMPLE
  $ cat my_songs.json | aspen store --app "music"
  Succesfully added 450 items

See code: src/commands/store.ts

Install

npm i @aspen.cloud/aspen-cli

DownloadsWeekly Downloads

1

Version

0.2.0

License

MIT

Unpacked Size

19.3 kB

Total Files

17

Last publish

Collaborators

  • avatar