crosscopy-cli v0.0.0

oclif-hello-world

oclif example Hello World CLI

• Usage
• Commands

Usage

$ npm install -g crosscopy-cli
$ xc COMMAND
running command...
$ xc (--version)
crosscopy-cli/0.0.0 darwin-arm64 node-v18.12.0
$ xc --help [COMMAND]
USAGE
  $ xc COMMAND
...

Commands

• xc autocomplete [SHELL]
• xc clear
• xc copy [FILE]
• xc default
• xc delete [FILE]
• xc help [COMMAND]
• xc listen
• xc login
• xc plugins
• xc plugins:install PLUGIN...
• xc plugins:inspect PLUGIN...
• xc plugins:install PLUGIN...
• xc plugins:link PLUGIN
• xc plugins:uninstall PLUGIN...
• xc plugins:uninstall PLUGIN...
• xc plugins:uninstall PLUGIN...
• xc plugins update
• xc profile add [FILE]
• xc profile delete [FILE]
• xc profile ls [FILE]
• xc profile rename [FILE]
• xc register
• xc setting
• xc setting set
• xc sync [LISTEN]
• xc update [CHANNEL]
• xc upload
• xc view

xc autocomplete [SHELL]

display autocomplete installation instructions

USAGE
  $ xc autocomplete [SHELL] [-r]

ARGUMENTS
  SHELL  shell type

FLAGS
  -r, --refresh-cache  Refresh cache (ignores displaying instructions)

DESCRIPTION
  display autocomplete installation instructions

EXAMPLES
  $ xc autocomplete

  $ xc autocomplete bash

  $ xc autocomplete zsh

  $ xc autocomplete --refresh-cache

See code: @oclif/plugin-autocomplete

xc clear

Clear config and data

USAGE
  $ xc clear [-d] [-c] [-a]

FLAGS
  -a, --all
  -c, --config
  -d, --data

DESCRIPTION
  Clear config and data

EXAMPLES
  $ xc clear

  $ xc clear --data

  $ xc clear --config

  $ xc clear --data --config

  $ xc clear --all

See code: dist/commands/clear.ts

xc copy [FILE]

Copy content piped to stdin

USAGE
  $ xc copy [FILE] [--image]

FLAGS
  --image  Image File, without this flag, files will be interpreted as UTF8 Text File

DESCRIPTION
  Copy content piped to stdin

EXAMPLES
  echo content | xc copy

  $ xc copy

  $ xc copy <filename.txt>

See code: dist/commands/copy.ts

xc default

Root Command

USAGE
  $ xc default

DESCRIPTION
  Root Command

See code: dist/commands/default.ts

xc delete [FILE]

Delete Records, Flags can be combined, each flag will be evaluated separately.

USAGE
  $ xc delete [FILE] [-a] [-s <value>] [-e <value>] [-y] [-i <value>] [-n <value>]

FLAGS
  -a, --all              delete all records
  -e, --end=<value>      end index
  -i, --idx=<value>      Index of record to delete
  -n, --numDays=<value>  Delete records older than n days
  -s, --start=<value>    start index
  -y, --yes              Confirm Deletion without prompt

DESCRIPTION
  Delete Records, Flags can be combined, each flag will be evaluated separately.

EXAMPLES
  $ xc delete

  $ xc delete --all

  $ xc delete --all -y

  $ xc delete --idx 6

  $ xc delete --start 6 --end 10

  $ xc delete --numDays=7

See code: dist/commands/delete.ts

xc help [COMMAND]

Display help for xc.

USAGE
  $ xc help [COMMAND] [-n]

ARGUMENTS
  COMMAND  Command to show help for.

FLAGS
  -n, --nested-commands  Include all nested commands in the output.

DESCRIPTION
  Display help for xc.

See code: @oclif/plugin-help

xc listen

Realtime Syncing

USAGE
  $ xc listen

DESCRIPTION
  Realtime Syncing

EXAMPLES
  $ xc listen

See code: dist/commands/listen.ts

xc login

Login to CrossCopy Cloud

USAGE
  $ xc login [-e <value>] [-p <value>] [--profile <value>] [--device <value>]

FLAGS
  -e, --email=<value>     Email
  -p, --password=<value>  Password
  --device=<value>        Device Name
  --profile=<value>       Profile Name

DESCRIPTION
  Login to CrossCopy Cloud

EXAMPLES
  $ xc login

  $ xc login -e username@email.com -p password

See code: dist/commands/login.ts

xc plugins

List installed plugins.

USAGE
  $ xc plugins [--core]

FLAGS
  --core  Show core plugins.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ xc plugins

See code: @oclif/plugin-plugins

xc plugins:install PLUGIN...

Installs a plugin into the CLI.

USAGE
  $ xc plugins:install PLUGIN...

ARGUMENTS
  PLUGIN  Plugin to install.

FLAGS
  -f, --force    Run yarn install with force flag.
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Installs a plugin into the CLI.
  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
  $ xc plugins add

EXAMPLES
  $ xc plugins:install myplugin 

  $ xc plugins:install https://github.com/someuser/someplugin

  $ xc plugins:install someuser/someplugin

xc plugins:inspect PLUGIN...

Displays installation properties of a plugin.

USAGE
  $ xc plugins:inspect PLUGIN...

ARGUMENTS
  PLUGIN  [default: .] Plugin to inspect.

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Displays installation properties of a plugin.

EXAMPLES
  $ xc plugins:inspect myplugin

xc plugins:install PLUGIN...

Installs a plugin into the CLI.

USAGE
  $ xc plugins:install PLUGIN...

ARGUMENTS
  PLUGIN  Plugin to install.

FLAGS
  -f, --force    Run yarn install with force flag.
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Installs a plugin into the CLI.
  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
  $ xc plugins add

EXAMPLES
  $ xc plugins:install myplugin 

  $ xc plugins:install https://github.com/someuser/someplugin

  $ xc plugins:install someuser/someplugin

xc plugins:link PLUGIN

Links a plugin into the CLI for development.

USAGE
  $ xc plugins:link PLUGIN

ARGUMENTS
  PATH  [default: .] path to plugin

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Links a plugin into the CLI for development.
  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.


EXAMPLES
  $ xc plugins:link myplugin

xc plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ xc plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ xc plugins unlink
  $ xc plugins remove

xc plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ xc plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ xc plugins unlink
  $ xc plugins remove

xc plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ xc plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ xc plugins unlink
  $ xc plugins remove

xc plugins update

Update installed plugins.

USAGE
  $ xc plugins update [-h] [-v]

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Update installed plugins.

xc profile add [FILE]

describe the command here

USAGE
  $ xc profile add [FILE] [-n <value>] [-f]

FLAGS
  -f, --force
  -n, --name=<value>  name to print

DESCRIPTION
  describe the command here

EXAMPLES
  $ xc profile add

xc profile delete [FILE]

describe the command here

USAGE
  $ xc profile delete [FILE] [-n <value>] [-f]

FLAGS
  -f, --force
  -n, --name=<value>  name to print

DESCRIPTION
  describe the command here

EXAMPLES
  $ xc profile delete

xc profile ls [FILE]

describe the command here

USAGE
  $ xc profile ls [FILE] [-n <value>] [-f]

FLAGS
  -f, --force
  -n, --name=<value>  name to print

DESCRIPTION
  describe the command here

EXAMPLES
  $ xc profile ls

xc profile rename [FILE]

describe the command here

USAGE
  $ xc profile rename [FILE] [-n <value>] [-f]

FLAGS
  -f, --force
  -n, --name=<value>  name to print

DESCRIPTION
  describe the command here

EXAMPLES
  $ xc profile rename

xc register

describe the command here

USAGE
  $ xc register [-e <value>] [-u <value>] [-p <value>]

FLAGS
  -e, --email=<value>     Email
  -p, --password=<value>  Password
  -u, --username=<value>  Username

DESCRIPTION
  describe the command here

EXAMPLES
  $ xc register -e example@email.com -u username -p password

  $ xc register -e example@email.com -u username

See code: dist/commands/register.ts

xc setting

Visualize Current Setting

USAGE
  $ xc setting

DESCRIPTION
  Visualize Current Setting

EXAMPLES
  $ xc setting

See code: dist/commands/setting/index.ts

xc setting set

Set Setting

USAGE
  $ xc setting set [--mode online|offline] [--server <value>] [--device <value>]

FLAGS
  --device=<value>  set device name
  --mode=<option>   set mode
                    <options: online|offline>
  --server=<value>  set server url

DESCRIPTION
  Set Setting

EXAMPLES
  $ xc setting set --mode=offline --server=http://api.crosscopy.io

xc sync [LISTEN]

Sync Data With CrossCopy Cloud

USAGE
  $ xc sync [LISTEN] [-i]

FLAGS
  -i, --image  Sync Image from clipboard, without this flag, sync clipboard text by default

DESCRIPTION
  Sync Data With CrossCopy Cloud

EXAMPLES
  $ xc sync

See code: dist/commands/sync.ts

xc update [CHANNEL]

update the xc CLI

USAGE
  $ xc update [CHANNEL] [-a] [-v <value> | -i] [--force]

FLAGS
  -a, --available        Install a specific version.
  -i, --interactive      Interactively select version to install. This is ignored if a channel is provided.
  -v, --version=<value>  Install a specific version.
  --force                Force a re-download of the requested version.

DESCRIPTION
  update the xc CLI

EXAMPLES
  Update to the stable channel:

    $ xc update stable

  Update to a specific version:

    $ xc update --version 1.0.0

  Interactively select version:

    $ xc update --interactive

  See available versions:

    $ xc update --available

See code: @oclif/plugin-update

xc upload

Upload some content

USAGE
  $ xc upload

DESCRIPTION
  Upload some content

EXAMPLES
  echo "content" | xc

  $ xc < content.txt

See code: dist/commands/upload.ts

xc view

View Clipboard Data

USAGE
  $ xc view [--uuid] [--id]

FLAGS
  --id    Display database (takes more space, but could be used to delete records)
  --uuid  Display UUID (takes more space, but could be used to delete records)

DESCRIPTION
  View Clipboard Data

EXAMPLES
  $ xc view

See code: dist/commands/view.ts