Commander icon indicating copy to clipboard operation
Commander copied to clipboard

Is there any documentation on the python classes and methods?

Open SubParJarJar opened this issue 4 years ago • 5 comments

Maybe it's me, but I can not find any documentation other than the sample .py files. It's all about the CLI. Is there documentation out there?

With kind regards, R2K

SubParJarJar avatar Jun 30 '21 15:06 SubParJarJar

If I remember correctly there's no documentation on the classes except for the comments inside of each script and what comes when using the commander which also can be found within the scripts (parameters).

I think the idea from the start is to use commander and not the scrips them self. I've worked some with the commander .py scripts due to the Powershell wrapper I've built.

tonylanglet avatar Jun 30 '21 17:06 tonylanglet

Thank you for the quick answer! I don't know if I'm asking this in the right channel either. If not I bid my apologies. I do have a follow up question: is there a way by which you can search for a specific map via string format, extract the UID and save it to a variable to work with later? I can only find Records with search, it is possible to find the right folder UID with cd and ls -l. But is it possible to then filter and extract?

SubParJarJar avatar Jun 30 '21 17:06 SubParJarJar

Unfortunately commands are not documented. Sorry for the late answer. I am not sure I understand the expected behavior. ls -lf pattern can be used to search for folders.

I can see that it would be helpful to add --recursive parameter to ls command. Also, ls output can be formated as either json or csv.

sk-keeper avatar Sep 17 '21 03:09 sk-keeper

Hi I stumbled across this page as I was looking for python documentation and keepercommander too. I want to read a password protected spreadsheet on python and have the password stored in the vault. What would be the best way to open the file?

byc-art avatar Dec 20 '21 15:12 byc-art

There is a keepercommander command for import from spreadsheet:

My Vault> import csv -h
usage: import [-h] [--display-csv] [--display-json] --format {json,csv,keepass,lastpass} [--folder FOLDER] [-s] [-p PERMISSIONS] [--update] [--users] [--old-domain OLD_DOMAIN]
              [--new-domain NEW_DOMAIN] [--file-cache TMPDIR]
              name

Import data from a local file into Keeper.

positional arguments:
  name                  file name (json, csv, keepass) or account name (lastpass)

optional arguments:
  -h, --help            show this help message and exit
  --display-csv, -dc    display Keeper CSV import instructions
  --display-json, -dj   display Keeper JSON import instructions
  --format {json,csv,keepass,lastpass}
                        file format
  --folder FOLDER       import into a separate folder.
  -s, --shared          import folders as Keeper shared folders
  -p PERMISSIONS, --permissions PERMISSIONS
                        default shared folder permissions: manage (U)sers, manage (R)ecords, can (E)dit, can (S)hare, or (A)ll, (N)one
  --update              Update records with common login, url or title
  --users               Update shared folder user permissions only
  --old-domain OLD_DOMAIN, -od OLD_DOMAIN
                        old domain for changing user emails in permissions
  --new-domain NEW_DOMAIN, -nd NEW_DOMAIN
                        new domain for changing user emails in permissions
  --file-cache TMPDIR   Temp directory used to cache encrypted attachment imports

kihneman avatar Dec 20 '21 17:12 kihneman