2023-12-18 13:12:25 +08:00
# clipboardy [](https://travis-ci.org/sindresorhus/clipboardy)
> Access the system clipboard (copy/paste)
2024-01-16 21:26:16 +08:00
Cross-platform. Supports: macOS, Windows, Linux, OpenBSD, FreeBSD, Android with [Termux ](https://termux.com/ ), [modern browsers ](https://developer.mozilla.org/en-US/docs/Web/API/Clipboard_API#Browser_compatibility ).
2023-12-18 13:12:25 +08:00
## Install
```
$ npm install clipboardy
```
## Usage
```js
const clipboardy = require('clipboardy');
clipboardy.writeSync('🦄');
clipboardy.readSync();
//=> '🦄'
```
## API
### clipboardy
#### .write(text)
Write (copy) to the clipboard asynchronously. Returns a `Promise` .
##### text
Type: `string`
The text to write to the clipboard.
#### .read()
Read (paste) from the clipboard asynchronously. Returns a `Promise` .
#### .writeSync(text)
Write (copy) to the clipboard synchronously.
2024-01-16 21:26:16 +08:00
Doesn't work in browsers.
2023-12-18 13:12:25 +08:00
##### text
Type: `string`
The text to write to the clipboard.
#### .readSync()
Read (paste) from the clipboard synchronously.
2024-01-16 21:26:16 +08:00
Doesn't work in browsers.
2023-12-18 13:12:25 +08:00
2024-01-16 21:26:16 +08:00
## FAQ
2023-12-18 13:12:25 +08:00
2024-01-16 21:26:16 +08:00
#### Where can I find the source of the bundled binaries?
2023-12-18 13:12:25 +08:00
2024-01-16 21:26:16 +08:00
The [Linux binary ](https://github.com/sindresorhus/clipboardy/blob/master/fallbacks/linux/xsel ) is just a bundled version of [`xsel` ](https://linux.die.net/man/1/xsel ). The source for the [Windows binary ](https://github.com/sindresorhus/clipboardy/blob/master/fallbacks/windows/clipboard_x86_64.exe ) can be found [here ](https://github.com/sindresorhus/win-clipboard ).
2023-12-18 13:12:25 +08:00
2024-01-16 21:26:16 +08:00
## Related
2023-12-18 13:12:25 +08:00
2024-01-16 21:26:16 +08:00
- [clipboard-cli ](https://github.com/sindresorhus/clipboard-cli ) - CLI for this module
- [copy-text-to-clipboard ](https://github.com/sindresorhus/copy-text-to-clipboard ) - Copy text to the clipboard in the browser