https://github.com/julius-boettger/colornote-to-json

A minimalistic wrapper for ColorNote backup decryptor
https://github.com/julius-boettger/colornote-to-json

colornote shell-script

Last synced: 5 days ago
JSON representation

A minimalistic wrapper for ColorNote backup decryptor

• Host: GitHub
• URL: https://github.com/julius-boettger/colornote-to-json
• Owner: julius-boettger
• License: gpl-3.0
• Created: 2024-04-24T12:41:21.000Z (7 months ago)
• Default Branch: main
• Last Pushed: 2024-04-26T07:13:52.000Z (7 months ago)
• Last Synced: 2024-04-27T07:39:51.295Z (7 months ago)
• Topics: colornote, shell-script
• Language: Shell
• Homepage:
• Size: 16.6 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# ColorNote to JSON

### A minimalistic wrapper for [ColorNote backup decryptor](https://github.com/olejorgenb/ColorNote-backup-decryptor)

Takes an encrypted ColorNote backup file as the input and outputs a JSON file containing all your notes like

```json

[

    {

        "title": "Title of the note",

        "content": "Content of the note"

    },

    ...

]

```

## Prerequisites

- `java` and `jq` are installed / accessible

- a Unix-like operating system

## Installation

```sh

git clone --recurse-submodules https://github.com/julius-boettger/colornote-to-json

cd colornote-to-json

```

## Usage

### Acquiring the ColorNote backup file

- Create a manual backup in ColorNote

    - Go to "Settings", "Backup", "Backup Notes"

    - Enter your password (you will need it again later!)

- Transfer the backup file to the device you want to run this script on

    - e.g. tap on the Backup and select "Send", followed by a service of your choice

### Running the script with your ColorNote backup file

```sh

# general usage:

./colornote-to-json.sh [input_backup_file_path] [output_json_file_path]

# for example...

./colornote-to-json.sh colornote-20240424.backup notes.json

```