Obsidian Setup Script

This repository contains scripts to automatically install Obsidian and configure it with your desired plugins on Linux, macOS, and Windows.

Files

install_obsidian.sh: Script to install Obsidian and configure plugins.
test_install_obsidian.sh: Script to test if Obsidian and the plugins are installed correctly.
plugins.json: Configuration file listing the core and community plugins to be installed.
Prerequisites

Windows

Git Bash: Download and install Git for Windows
Chocolatey: Install Chocolatey

Linux

wget
jq

macOS

Homebrew: Install Homebrew

Usage

1. Clone the Repository

Open your terminal or Git Bash and clone the repository:

git clone <your-repo-url> cd <your-repo-name>

2. Run the Installation Script

To install Obsidian and configure the plugins, run:

./install_obsidian.sh

3. Run the Test Script

To verify the installation, run the test script:

./test_install_obsidian.sh

Configuration

`plugins.json`

This file lists the core and community plugins to be installed. Modify this file to add or remove plugins as needed.

{   
	"core_plugins": [
	    "core-plugin-id-1",
	    "core-plugin-id-2"
	],   
	"community_plugins": [     
		"community-plugin-id-1",     
		"community-plugin-id-2"   
	] 
}

Troubleshooting

Obsidian Installation Failed

If the installation script fails to install Obsidian, check the following:

Ensure you have the required dependencies installed.
Check the output of the script for any error messages.
Verify that the download URL for Obsidian is correct.

Plugins Not Enabled/Installed

If the plugins are not enabled or installed:

Ensure the plugins.json file is correctly formatted and the plugin IDs are correct.
Check the output of the script for any error messages.
Verify the plugin files/directories are created in the appropriate location.

License

This project is licensed under the MIT License.

2.1 KiB Raw Blame History