# crosscopy-cli

> CrossCopy CLI

Latest version **0.0.0** (published 2022-12-24) · MIT license · 0 weekly downloads

## Install

```sh
npm install crosscopy-cli
pnpm add crosscopy-cli
yarn add crosscopy-cli
bun add crosscopy-cli
```

Provides the command `xc`.

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.0 |
| Published | 2022-12-24 |
| First published | 2022-12-24 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >=12.0.0 |
| Dependencies | 29 |
| Unpacked size | 138 KB |
| Known vulnerabilities | 0 (+24 in 2 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Huakun Shen @HuakunShen |
| Maintainers | huakunshen |
| Keywords | oclif |

## Links

- npm: https://www.npmjs.com/package/crosscopy-cli
- Repository: https://github.com/CrossCopy/crosscopy-client-cli
- Issues: https://github.com/CrossCopy/crosscopy-client-cli/issues
- npm.io page: https://npm.io/package/crosscopy-cli

## Dependencies (29)

- [zod](https://npm.io/package/zod.md) ^3.19.1
- [uuid](https://npm.io/package/uuid.md) ^8.3.2
- [axios](https://npm.io/package/axios.md) ^0.27.2
- [boxen](https://npm.io/package/boxen.md) ^7.0.0
- [bytes](https://npm.io/package/bytes.md) ^3.1.2
- [chalk](https://npm.io/package/chalk.md) ^4.1.2
- [debug](https://npm.io/package/debug.md) ^4.3.4
- [nconf](https://npm.io/package/nconf.md) ^0.12.0
- [dotenv](https://npm.io/package/dotenv.md) ^16.0.1
- [figlet](https://npm.io/package/figlet.md) ^1.5.2
- [lodash](https://npm.io/package/lodash.md) ^4.17.21
- [graphql](https://npm.io/package/graphql.md) ^16.6.0
- [typeorm](https://npm.io/package/typeorm.md) ^0.3.7
- [fs-extra](https://npm.io/package/fs-extra.md) ^10.1.0
- [inquirer](https://npm.io/package/inquirer.md) ^8.2.3
- [clipboardy](https://npm.io/package/clipboardy.md) ^2.3.0
- [@oclif/core](https://npm.io/package/@oclif/core.md) ^1
- [@types/uuid](https://npm.io/package/@types/uuid.md) ^8.3.4
- [graphql-tag](https://npm.io/package/graphql-tag.md) ^2.12.6
- [@crosscopy/core](https://npm.io/package/@crosscopy/core.md) 0.0.5-alpha.14
- [graphql-request](https://npm.io/package/graphql-request.md) ^4.3.0
- [@types/crypto-js](https://npm.io/package/@types/crypto-js.md) ^4.1.1
- [socket.io-client](https://npm.io/package/socket.io-client.md) ^4.5.1
- [@oclif/plugin-help](https://npm.io/package/@oclif/plugin-help.md) ^5
- [@crosscopy/clipboard](https://npm.io/package/@crosscopy/clipboard.md) ^0.1.4
- [@oclif/plugin-update](https://npm.io/package/@oclif/plugin-update.md) ^3.0.0
- [@oclif/plugin-plugins](https://npm.io/package/@oclif/plugin-plugins.md) ^2.0.1
- [@crosscopy/graphql-schema](https://npm.io/package/@crosscopy/graphql-schema.md) 0.1.3-pre-alpha.5
- [@oclif/plugin-autocomplete](https://npm.io/package/@oclif/plugin-autocomplete.md) ^1.3.0

## Alternatives

- [@salesforce/cli](https://npm.io/package/@salesforce/cli.md) — 389.7K weekly downloads
- [@mintlify/cli](https://npm.io/package/@mintlify/cli.md) — 208.9K weekly downloads
- [@grafana/e2e-selectors](https://npm.io/package/@grafana/e2e-selectors.md) — 128.7K weekly downloads
- [mintlify](https://npm.io/package/mintlify.md) — 112.0K weekly downloads
- [@intlayer/cli](https://npm.io/package/@intlayer/cli.md) — 22.8K weekly downloads

## Recent versions

- 0.0.0 (latest) — 2022-12-24

## README

oclif-hello-world
=================

oclif example Hello World CLI

[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)
[![Version](https://img.shields.io/npm/v/oclif-hello-world.svg)](https://npmjs.org/package/oclif-hello-world)
[![CircleCI](https://circleci.com/gh/oclif/hello-world/tree/main.svg?style=shield)](https://circleci.com/gh/oclif/hello-world/tree/main)
[![Downloads/week](https://img.shields.io/npm/dw/oclif-hello-world.svg)](https://npmjs.org/package/oclif-hello-world)
[![License](https://img.shields.io/npm/l/oclif-hello-world.svg)](https://github.com/oclif/hello-world/blob/main/package.json)

<!-- toc -->
* [Usage](#usage)
* [Commands](#commands)
<!-- tocstop -->
# Usage
<!-- usage -->
```sh-session
$ 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
...
```
<!-- usagestop -->
# Commands
<!-- commands -->
* [`xc autocomplete [SHELL]`](#xc-autocomplete-shell)
* [`xc clear`](#xc-clear)
* [`xc copy [FILE]`](#xc-copy-file)
* [`xc default`](#xc-default)
* [`xc delete [FILE]`](#xc-delete-file)
* [`xc help [COMMAND]`](#xc-help-command)
* [`xc listen`](#xc-listen)
* [`xc login`](#xc-login)
* [`xc plugins`](#xc-plugins)
* [`xc plugins:install PLUGIN...`](#xc-pluginsinstall-plugin)
* [`xc plugins:inspect PLUGIN...`](#xc-pluginsinspect-plugin)
* [`xc plugins:install PLUGIN...`](#xc-pluginsinstall-plugin-1)
* [`xc plugins:link PLUGIN`](#xc-pluginslink-plugin)
* [`xc plugins:uninstall PLUGIN...`](#xc-pluginsuninstall-plugin)
* [`xc plugins:uninstall PLUGIN...`](#xc-pluginsuninstall-plugin-1)
* [`xc plugins:uninstall PLUGIN...`](#xc-pluginsuninstall-plugin-2)
* [`xc plugins update`](#xc-plugins-update)
* [`xc profile add [FILE]`](#xc-profile-add-file)
* [`xc profile delete [FILE]`](#xc-profile-delete-file)
* [`xc profile ls [FILE]`](#xc-profile-ls-file)
* [`xc profile rename [FILE]`](#xc-profile-rename-file)
* [`xc register`](#xc-register)
* [`xc setting`](#xc-setting)
* [`xc setting set`](#xc-setting-set)
* [`xc sync [LISTEN]`](#xc-sync-listen)
* [`xc update [CHANNEL]`](#xc-update-channel)
* [`xc upload`](#xc-upload)
* [`xc view`](#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](https://github.com/oclif/plugin-autocomplete/blob/v1.3.6/src/commands/autocomplete/index.ts)_

## `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](https://github.com/CrossCopy/crosscopy-client-cli/blob/v0.0.0/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](https://github.com/CrossCopy/crosscopy-client-cli/blob/v0.0.0/dist/commands/copy.ts)_

## `xc default`

Root Command

```
USAGE
  $ xc default

DESCRIPTION
  Root Command
```

_See code: [dist/commands/default.ts](https://github.com/CrossCopy/crosscopy-client-cli/blob/v0.0.0/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](https://github.com/CrossCopy/crosscopy-client-cli/blob/v0.0.0/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](https://github.com/oclif/plugin-help/blob/v5.1.19/src/commands/help.ts)_

## `xc listen`

Realtime Syncing

```
USAGE
  $ xc listen

DESCRIPTION
  Realtime Syncing

EXAMPLES
  $ xc listen
```

_See code: [dist/commands/listen.ts](https://github.com/CrossCopy/crosscopy-client-cli/blob/v0.0.0/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](https://github.com/CrossCopy/crosscopy-client-cli/blob/v0.0.0/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](https://github.com/oclif/plugin-plugins/blob/v2.1.7/src/commands/plugins/index.ts)_

## `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](https://github.com/CrossCopy/crosscopy-client-cli/blob/v0.0.0/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](https://github.com/CrossCopy/crosscopy-client-cli/blob/v0.0.0/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](https://github.com/CrossCopy/crosscopy-client-cli/blob/v0.0.0/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](https://github.com/oclif/plugin-update/blob/v3.0.7/src/commands/update.ts)_

## `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](https://github.com/CrossCopy/crosscopy-client-cli/blob/v0.0.0/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](https://github.com/CrossCopy/crosscopy-client-cli/blob/v0.0.0/dist/commands/view.ts)_
<!-- commandsstop -->

---
_Source: https://npm.io/package/crosscopy-cli · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
