/Starry

Small backup script made in C#, complete with a config file~

Primary LanguageC#MIT LicenseMIT

Starry

Starry is a simple, cross-platform, backup tool written in C#. Starry is used to quickly and easily backup your files and directories, automatically compressing them at your will using its configuration system.

Installation

Pre-requisites

Starry is written in C#, and it uses python for the setup. To install Starry, you will need to also install dotnet and python.

For Linux

# Fedora
sudo dnf in dotnet-runtime-8.0 dotnet-sdk-8.0 python3

# Arch
sudo pacman -S dotnet-runtime dotnet-sdk python

# Ubuntu based distributions
sudo apt-get install dotnet-runtime-8.0 dotnet-sdk-8.0 python3

For Windows

Using choco

choco install python dotnet

Manually

Visit the following sites.
https://learn.microsoft.com/en-us/dotnet/core/install/windows?tabs=net80
https://www.python.org/downloads/

That's it! You are now ready to install Starry.

Using setup.py

git clone https://github.com/its-Lyn/Starry
cd Starry/

python setup.py help

# After you've read the help. You can install it.
python setup.py build

# On Linux
sudo python setup.py install

# On Windows, you need to open powershell as administrator.
python setup.py install

starry help

Compiling without setup.py

git clone https://github.com/its-Lyn/Starry
cd Starry/

dotnet publish -c Release -p:PublishSingleFile=true
cd Starry/bin/Release/net8.0/<your-os>-<your-arch>/publish

# On Linux
sudo mv ./Starry /usr/local/bin/starry

# On Windows, you need to open powershell as administrator
Move-Item .\Starry C:\Windows\system32

starry help

Uninstalling

Uninstalling Starry is as easy as running two commands!

# Using setup.py
sudo python setup.py uninstall

# You mustn't use sudo for this command if you're on linux.
python setup.py rconf

But you can always just do it manually.

sudo rm /usr/local/bin/starry

# Removing the configuration.

# If you have set XDG_CONFIG_HOME 
rm -rf -I $XDG_CONFIG_HOME/Starry
# Else
rm -rf -I ~/.config/Starry

Usage

"Starry being used."

Starry has a small config system. If you'd like to learn more, please take a look at the documentation

Starry also keeps track of your previous backups! You can see how it works here!

License

MIT