Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/quinta0/obsidiansetup
An utility script to make installing Obsidian and it's plugins from device to device more easier
https://github.com/quinta0/obsidiansetup
bash obsidian obsidian-community obsidian-plugin powershell script utility
Last synced: 4 days ago
JSON representation
An utility script to make installing Obsidian and it's plugins from device to device more easier
- Host: GitHub
- URL: https://github.com/quinta0/obsidiansetup
- Owner: Quinta0
- License: mit
- Created: 2024-06-08T18:49:18.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2024-10-17T10:08:03.000Z (28 days ago)
- Last Synced: 2024-10-19T13:39:24.418Z (26 days ago)
- Topics: bash, obsidian, obsidian-community, obsidian-plugin, powershell, script, utility
- Language: PowerShell
- Homepage: https://quinta0.github.io/
- Size: 79.1 MB
- Stars: 10
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
# 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 on Linux and macOS.
- `install_obsidian.ps1`: Script to install Obsidian and configure plugins on Windows.
- `plugins.json`: Configuration file listing the core and community plugins to be installed.
## Prerequisites
### Windows
- Git Bash: [Download and install Git for Windows](https://gitforwindows.org/)
- PowerShell with administrative privileges
### Linux
- wget
- jq
### macOS
- Homebrew: [Install Homebrew](https://brew.sh/)
## Usage
### 1. Clone the Repository
Open your terminal or Git Bash and clone the repository:
```bash
git clone [email protected]:Quinta0/ObsidianSetup.git
cd ObsidianSetup
```
### 2. For Windows
1) Open PowerShell as Administrator.
2) Navigate to the repository directory:
```bash
cd ObsidianSetup
```
3) Run the PowerShell script:
```bash
.\install_obsidian.ps1
```
### 3. For Linux and macOS
1) Open your terminal.
2) Navigate to the repository directory:
```bash
cd ObsidianSetup
```
3) Run the Bash script:
```bash
./install_obsidian.sh
```
4) Follow the prompts to select your operating system.
## Configuration
`plugins.json`
This file lists the core and community plugins to be installed. Modify this file to add or remove plugins as needed.
```json
{
"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.
## Thanks for the stars
[](https://github.com/Quinta0/ObsidianSetup/stargazers)