HOME
If you have not set up your square pass successfully on your machine already, please read the setup process here.
⭐️ Read Frequently Asked QNA here ⭐️
-
Add Login Credential :
sq -P -
Add Quick Notes :
sq -N <Title> -
Add Keys :
sq -K <KeyName>
- passw : Passwords Manager
- keys : Key Manager
- notes : Notes Manager
sq --ls <Service_Name>*
eg : sq --ls [passw] [keys] [notes] ]
Gives:
As the following name suggests, you can directly access one particular credential by a special method.
sq -l
As the following name suggests, you can directly access one particular credential by a special method.
sq -cat <service_name/index_number>
Of course, this one is more handy as you can directly access what you want, but it comes with the limitation that to access this particular information, you have to memorize the index_number, which you can see in the list view.
e.g, to view your 'That one fake Instagram' password, which you know is in 10th index. sq -cat passw/10 gives:
⭐️ Read more about filtering your output here ⭐️
⭐️ Read more about configuring your output theme here ⭐️
Required arguments are marked with an asterisk (*) at the end of the parameter name.
Any arguments not marked with an asterisk are considered optional and will not result in errors if omitted.
|| e.g, sq --ls requires <service_name> as a mandatory argument while sq -N optionally takes <title> ||
sq -U <service_name/index>*
The following command will ask you to re-enter the credentials; once you do that, it will replace the old credential with a new credential. If you leave any field blank, it won't replace it; don't worry.
N.B : You won't be able to modify notes.
sq -rm <service_name/id>*
Filtration flags allow you to sort out your output, for example, if you want to see your only your Facebook passwords, or passwords of certain username, or perhaps you want to do both at once. Do the filtration as instructed below.
-a, appname: This flag takes, one argument,the app name, by which the filtration will be applied. sq --ls passw -a <APPNAME>
-u, username: This flag takes, one argument,the username, by which the filtration will be applied. sq --ls passw -u <USERNAME>
If passed down both flags by default, it will sort out all of the credentials that match even a single condition.
If you want to see the credentials that are true to both conditions, then pass -b. e.g sq --ls passw -a <APPNAME> -u <USERNAME> -b
The filtration feature is only available with --ls command till now.
-d , --dupe : Copies the secret key directory to your clipboard if passed down. sq -cat passw/1 -d
-R , --recent : Shows recently modifies credential first (ASC). sq --ls passw -R
-s , --show (n) : Shows secret keys while typing hidden credentials . sq -K -s
-c , --count : Shows recently modifies credential first. sq --ls passw -c
-i , --ignorecase : Ignores case sensitivity. sq --ls passw -u yOUr_uSErNAME -i
-l, --logcache : allows you to cache your master password for a desired amount of time. sq -l
-G , --generate : generates a password to you clipboard. e.g sq -G <length>*
--BIGBANG : Allows you to erase all your data at once. e.g, sq --bigbang <Service_Name>
Your configuration file is stored in ~/.config/sqpass/config.yaml, and if you are doing configurations,
boy you don't need reading documents here, it's already simple, and you already know what to do.
The colors supported in config,are here