https://github.com/ceejbot/nuc2not
Migrate a Nuclino workspace to a Notion page.
https://github.com/ceejbot/nuc2not
Last synced: 3 months ago
JSON representation
Migrate a Nuclino workspace to a Notion page.
- Host: GitHub
- URL: https://github.com/ceejbot/nuc2not
- Owner: ceejbot
- License: other
- Created: 2024-06-19T01:21:59.000Z (about 2 years ago)
- Default Branch: latest
- Last Pushed: 2025-01-08T19:29:12.000Z (over 1 year ago)
- Last Synced: 2025-02-24T03:56:39.549Z (over 1 year ago)
- Language: Rust
- Size: 300 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Nuc2Not
[](https://github.com/ceejbot/nuc2not/actions/workflows/test.yaml)
This is a command-line tool that migrates Nuclino wiki pages to Notion pages.
The tool does not fully migrate content to Notion because of missing functionality in the Notion API. Specifically, you can't upload images or file downloads via its public API. This tool definitely succeeds in making a local backup of Nuclino wiki pages with metadata and media, but it's reduced to prompting you to upload media by hand.
## Migrating a workspace
You'll need to do some steps in both Nuclino and Notion to set yourself up to use their APIs.
1. Install the [fzf](https://github.com/junegunn/fzf) fuzzy finder. On MacOS, I do this with homebrew.
2. Make a Nuclino API key. Provide this key to your environment any way you like as `NUCLINO_API_KEY`. `nuc2not` reads a `.env` file if one is in the directory it's run in.
3. Create a Notion integration. Provide its secret to your environment any way you like as `NOTION_API_KEY`.
4. In Notion, choose a root page where you want your imported pages to start out. (You can move them later.) In the top right of the Notion window, choose the three-dots menu and connect the root page to your new integration.
5. Use the `share` button to get the link of your chosen root page. The hexadecimal string at the end of the URL is the page id. Make a note of this; you'll need to provide it to the tool for all migration actions.
6. Run this tool to create a cache of the workspace or workspaces you want to migrate.
7. Now migrate some or all of the pages in that cache to Notion.
You must cache pages before trying to migrate them. This is a design choice. My goal was to back up our Nuclino wiki and all its meta data just to have it around, then decide what to do with it.
```text
nuc2not cache # fill the cache for a workspace
nuc2not migrate-workspace # migrate a entire cached workspace
nuc2not migrate-page -p # migrate a few pages
```
## Usage
Each subcommand has more detailed help.
```text
Usage: nuc2not [OPTIONS]
Commands:
cache Cache a Nuclino workspace locally. You'll be prompted to select the workspace
inspect-cache Inspect your local cache, listing pages by id
migrate-page Migrate a single page by id. If the page has media, you'll be prompted to
upload the media by hand: the Notion API does not have endpoints for doing
this automatically
migrate-workspace Migrate a previously-cached Nuclino workspace to Notion. Unreliable!!
help Print this message or the help of the given subcommand(s)
Options:
-w, --wait How many milliseconds to wait between Nuclino requests [default: 750]
-h, --help Print help
-V, --version Print version
```
## TODO list
Here are some features I'm contemplating implementing.
- [ ] Updating migrated Nuclino pages with links to their Notion versions. Should be easy.
- [ ] Doing something to connect migrated pages with author information, even if I can't set a page's author directly when creating a page. Less easy than the link-back, because it involves constructing Notion block content, but still not hard.
- [ ] Doing something smarter than just blanket waits between requests to avoid hitting rate limits. In particular, a page with lots of deep nested lists that force lots of repeated append calls can take a long time to create, even when it's not a lot of content in word count.
## LICENSE
This code is licensed via [the Parity Public License.](https://paritylicense.com) This license requires people who build on top of this source code to share their work with the community, too. See the license text for details.