use-memos-cli 0.1.2

A CLI tool for interacting with the Memos API through a self hosted instance.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82

#Use Memos CLI

Memos CLI is a command-line interface tool for managing memos through a self-hosted API. It allows users to retrieve, create, and update memos efficiently.

## Features

- Retrieve all memos from the API
- Create new memos (placeholder functionality)
- Update existing memos (single or bulk update)
- Save memos as local files
- Maintain memo metadata in a JSON file

## Installation

1. Ensure you have Rust and Cargo installed on your system.
2. Clone this repository:
   ```
   git clone https://github.com/yourusername/memos-cli.git
   cd use-memos-cli
   ```
3. Build the project:
   ```
   cargo build --release
   ```
4. The binary will be available in `target/release/use-memos-cli`

## Usage

Before using the CLI, make sure to set the following environment variables:
- `MEMOAPI`: Your API authentication token
- `MEMO_DOMAIN`: The domain of your self-hosted memo instance

You can set these in a `.env` file in the project root.

### General Command Structure

```
use-memos-cli [OPTIONS] --endpoint <ENDPOINT>
```

### Options

- `-m, --memo-domain <MEMO_DOMAIN>`: Memo domain of self-hosted instance
- `-e, --endpoint <ENDPOINT>`: API endpoint to call (getMemos, createMemo, updateMemo)
- `-o, --output-dir <OUTPUT_DIR>`: Output directory for files [default: content]
- `-v, --verbose`: Verbose mode
- `-n, --memo-name <MEMO_NAME>`: Memo name or uid (for single memo operations)
- `-c, --content <CONTENT>`: Optional content for memo creation or update
- `--bulk-update`: Flag for bulk update of memos

### Examples

1. Retrieve all memos:
   ```
   use-memos-cli --endpoint getMemos
   ```

2. Update a single memo:
   ```
   use-memos-cli --endpoint updateMemo --memo-name <MEMO_UID> --content "Updated content"
   ```

3. Bulk update all memos:
   ```
   use-memos-cli --endpoint updateMemo --bulk-update
   ```

## Project Structure

- `src/`
  - `main.rs`: Entry point of the application
  - `cli.rs`: CLI argument parsing
  - `utils.rs`: Utility functions
  - `api/`
    - `mod.rs`: API module definitions
    - `getMemos.rs`: Functions for retrieving memos
    - `createMemo.rs`: Functions for creating memos (placeholder)
    - `updateMemo.rs`: Functions for updating memos

## Contributing

Contributions are welcome! Please feel free to submit a Pull Request.