Skip to content
This repository has been archived by the owner on Feb 8, 2023. It is now read-only.

jaedsonpys/vestory

Repository files navigation

Vestory - Fast, simple and practical

BADGE BADGE

Vestory (junction of "Version" and "History"), is a practical and fast version control used in any terminal by command line (CLI). With simple and easy-to-remember commands, making it easy to use. With Vestory, you can:

  • Monitor file changes;
  • Merge file changes;
  • Save file changes;
  • View change logs;
  • Ignore files.

Version control better than Vestory is now available, meet Pie now!

Installation

To install Vestory, use the PyPi package manager:

pip install vestory

After that, you can use it from the command line with the vestory command.

Using the Vestory

First, see the list of commands available so far:

  • init: creates a new repository;
  • add [files]: adds files to change tracking;
  • submit: saves the changes made so far.

Initializing repository

To initialize a repository, use the init command:

vestory init

Before that, your settings must be done to initialize a repository correctly.

Add files

To add files to change tracking:

vestory add example.txt

It is also possible to add several files at once, typing the name of each one or using the -a flag:

vestory add example.txt test.py project/app.py
vestory add -a

the -a flag adds all files present in the directory.

Submit changes

To commit a change, you need to specify the files, or commit the change of all files that were added using the -a flag.

It is also necessary to add a comment about that change, for this we use the -c flag. See an example:

vestory submit example.txt -c 'first changes'

You can commit changes to all monitored files and add a comment using the -ac abbreviation:

vestory submit -ac 'first changes'

Merge changes

With the join argument, you will merge all changes to a file, replacing the original file. See the use of this argument:

vestory join

Note that a warning message will appear before the process is carried out:

warning: the "join" command will replace the current files.
> Do you wish to proceed? [y/n]

Confirming, the process will be carried out.

View change log

To see all the changes that have been made, use the log argument:

vestory log

The following information will be displayed:

  • Author name
  • Author's email
  • Date of change
  • change ID
  • Comment on the change

Status of files

The status of the file shows whether it has been changed or not, to check this information use the status argument:

vestory status

Ignoring files or directories

To ignore files or directories, create a file at the root of your directory called .ignoreme. Add line by line each file/directory that will be ignored. By ignoring a file, it will not be added to the change tracking when using the add -a command, nor will it have its changes committed.

When adding subdirectories to .ignoreme, do it like this:

dir/subdir

License

GNU GENERAL PUBLIC LICENSE
Version 3, 29 June 2007

Copyright (C) 2007 Free Software Foundation, Inc. https://fsf.org/ Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.