Skip to content

Using the CLI

Installation

$ pip install hopcolony

---> 100%

Login

Before you start using the CLI, you will need to login with your user:

hopctl login

After signing in with the pop-up browser window, you will get prompted to select the project you want to work on.

You can always check the config of your current project by doing:

$ hopctl config get

project: example_project
token: LypdFfm7ZQhjZTt
username: example@hopcolony.io

Authentication

You can list all the users in the project:

$ hopctl get user

TODO

You can describe a specific user with:

$ hopctl describe user uid

TODO

Documents

You can get all the indices in your database:

$ hopctl get index

TODO

You can then describe a specific index:

$ hopctl describe index users

TODO

If you want to get some specific fields from the documents, user the cols flag:

$ hopctl describe index users --cols name,surname,email

TODO

You can also describe a specific doc by providing the uuid:

$ hopctl describe index users --doc dsfsdf

TODO

Drive

You can list all the buckets in the database:

$ hopctl get bucket

TODO

You can describe the bucket to get all the objects within it:

$ hopctl describe bucket photos

TODO

You can also describe a specific object in the bucket:

$ hopctl describe bucket photos --obj sea.png

TODO