Skip to content

Export all your Nuclino documents to Markdown files

License

Notifications You must be signed in to change notification settings

DanzigerGeist/nuclino-exporter

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

📚 Nuclino Workspace Exporter

This Python script exports all Nuclino workspaces into a local folder, preserving the hierarchy of collections (folders) and items (documents). Documents are saved as Markdown (.md) files.


🚀 Features

  • Exports all workspaces under the Nuclino account.
  • Creates folder structures for collections.
  • Saves documents as .md files, named by their titles.

⚙️ Installation

1. Clone the Repository

git clone https://github.com/DanzigerGeist/nuclino-exporter.git
cd nuclino-exporter

2. Create a Virtual Environment

python3 -m venv venv
source venv/bin/activate  # On Windows: .\venv\Scripts\activate

3. Install Required Packages

pip install -r requirements.txt

📝 Usage

Run the script with the required --apiKey argument:

python export_nuclino.py --apiKey YOUR_NUCLINO_API_KEY

Optional: Specify a custom output directory:

python export_nuclino.py --apiKey YOUR_NUCLINO_API_KEY --outputDir ./my_exports

🛠️ CLI Options

Argument Required Default Description
--apiKey ✅ Yes N/A Your Nuclino API key
--outputDir ❌ No ./export Directory to store exported files

⚖️ License

This project is licensed under the MIT License. See the LICENSE file for details.

About

Export all your Nuclino documents to Markdown files

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages