Configure

Login or Register

To configure WordBucket in a project we have to initialize it using the command

wordbucket init

When executed this command two options are presented, from which we choose one.

$ wordbucket init
? What would you like to do? (Use arrow keys)
❯ Login 
  Register

Register

We are asked to fill the following information: username, password, verification password, mail, first name and last name.

$ wordbucket init
? What would you like to do? Register
? Username: wordbucket
? Password: ****
? Retype Password: ****
? Mail: [email protected]
? First Name: WordBucket
? Last Name: Demo
Welcome WordBucket Demo

Login

We are asked to fill the following information: username or mail and password.

$ wordbucket init
? What would you like to do? Login
? Username or Mail: wordbucket
? Password: ****
Welcome WordBucket Demo

Create or Use app

After logging in or registering the account, we need to tell WordBucket which app to configure in our project.

? What would you like to do? (Use arrow keys)
❯ Create a new app 
  Use an existing app

Create a new app

We are asked the name of the new app.

? What would you like to do? Create a new app
? Name: CV
App "CV" created successfully
WordBucket successfully initialized in this project

Use an existing app

We are shown a list with our available apps for us to choose one.

? What would you like to do? Use an existing app
? Name: (Use arrow keys)
❯ CV

When we have chosen the app, something like this will show up:

? What would you like to do? Use an existing app
? Name: CV
App "CV" chosen successfully
WordBucket successfully initialized in this project

Stored information

After the above steps, in the current directory are created a file .wordbucket and a folder wordbucket.

File .wordbucket

• Session token;

• App name and id;

• User's username.

Folder wordbucket

• contents

  • <container name>

    • <content name>.json

• structures

  • <structure name>.json

Pull informations

After the above steps we are asked if we wish to pull the containers, structures and contents.

? Pull containers, structures and contents? (Y/n)

Pull

If we wish to pull, Wor folder will be filled and the command will end its execution.

? Pull containers, structures and contents? Yes
Local structures are up to date with remote
Local containers are up to date with remote

Don't pull

If we don't wish to pull, WordBucket does nothing more and will end the execution of the command.

? Pull containers, structures and contents? No