https://github.com/moekiorg/cs
An unofficial CLI tool for seamless interaction with the Cosense API
https://github.com/moekiorg/cs
cosense scrapbox
Last synced: 2 months ago
JSON representation
An unofficial CLI tool for seamless interaction with the Cosense API
- Host: GitHub
- URL: https://github.com/moekiorg/cs
- Owner: moekiorg
- License: mit
- Created: 2024-10-05T12:10:59.000Z (8 months ago)
- Default Branch: master
- Last Pushed: 2024-10-05T21:52:53.000Z (8 months ago)
- Last Synced: 2025-04-02T03:37:33.440Z (2 months ago)
- Topics: cosense, scrapbox
- Language: Rust
- Homepage:
- Size: 183 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
CS
An unofficial CLI tool for seamless interaction with the Cosense API
Installation •
Quick Start •
Detailed Usage •
Contributing •
License
## Installation
### Linux
```bash
curl -L https://github.com/kawakamimoeki/cs/releases/download/v0.1.16/cs-linux-amd64 -o cs
chmod +x cs
sudo mv cs /usr/local/bin/
```
### macOS
```bash
curl -L https://github.com/kawakamimoeki/cs/releases/download/v0.1.16/cs-macos-amd64 -o cs
chmod +x cs
sudo mv cs /usr/local/bin/
```
### Windows
```powershell
Invoke-WebRequest https://github.com/kawakamimoeki/cs/releases/download/v0.1.16/cs-windows-amd64.exe -OutFile cs.exe
Move-Item .\cs.exe C:\Windows\System32\
```
## Quick Start
1. Login to your Cosense account:
```
cs login your-connect-sid
```
2. Set a project:
```
cs project your-project
```
3. Find pages:
```
cs find "your search query" --link
```
## Detailed Usage
### Global Options
All commands support the following global options:
- `--help`: Show help information for the command
### Login
Authenticate with Cosense using your `connect.sid` cookie:
```
cs login
```
### Project
Set a project:
```
cs switch
```
Options:
- `--url` or `-u`: Display the API URL instead of fetching the page
- `--web` or `-w`: Open the project in a web browser
### List
List page titles for a project:
```
cs ls [options]
```
Options:
- `--skip ` or `-s `: Skip a number of pages
- `--limit ` or `-l `: Limit the number of pages returned
- `--url` or `-u`: Display the API URL instead of fetching data
- `--link`: Include page links in the output
- `--json` or `-j`: Display the API URL instead of fetching the page
Example:
```
cs ls --limit 20 --link
```
### Page
View or open a page:
```
cs view [options]
```
Options:
- `--body` or `b`: Add body to page
- `--web` or `-w`: Open the page in a web browser
- `--url` or `-u`: Display the API URL instead of fetching the page
- `--json` or `-j`: Display the API URL instead of fetching the page
Examples:
```
cs view my-page
cs view my-page --web
```
### Get resource
Get resource from a page:
```
cs get [options]
```
Options:
- `--url` or `-u`: Display the API URL instead of fetching the resource
- `--resource` or `-t`: Specify the type of resource to retrieve
- `code`: Retrieve code snippets
- `table`: Retrieve tables
- `icon`: Retrieve icons
Example:
```
cs get my-page/my-code-snippet --resource code
cs get my-page/my-table-name --resource table
cs get my-page --resource icon
```
### Find
Find pages:
```
cs find [options]
```
Options:
- `--url` or `-u`: Display the API URL instead of performing the search
- `--link` or `-l`: Include links to the search results
- `--web` or `-w`: Open the search results in a web browser
- `--json` or `-j`: Display the API URL instead of performing the search
Example:
```
cs search "important topic" --link
```
## License
Distributed under the MIT License. See [LICENSE](LICENSE.txt) for more information.
## Support
If you encounter any issues or have questions, please [open an issue](https://github.com/kawakamimoeki/cs/issues/new) on our GitHub repository.
---
Made with ❤️ by kawakamimoeki