Estela CLI Reference

This page provides documentation for the Estela CLI.

estela

Usage:

estela [OPTIONS] COMMAND [ARGS]...

Options:

  --version  Show the version and exit.
  --help     Show this message and exit.

Subcommands

context: Show your current context
create: Create a resource
data: Retrieve data from a given job and save it locally
delete: Delete a resource
deploy: Deploy Scrapy project to estela API
init: Initialize estela project for existing web scraping project
list: Display the available resources
login: Save your credentials
logout: Remove your credentials
stop: Stop an active job or cronjob
update: Update a resource

estela context

Show your current context

Usage:

estela context [OPTIONS]

Options:

  --help  Show this message and exit.

estela create

Create a resource

Usage:

estela create [OPTIONS] COMMAND [ARGS]...

Options:

  --help  Show this message and exit.

Subcommands

cronjob: Create a new cronjob
job: Create a new job
project: Create a new project

estela create cronjob

Create a new cronjob

SCHEDULE is the crontab schedule expression for the cronjob
SID is the spider's sid
PID is the project's pid (active project by default)

Usage:

estela create cronjob [OPTIONS] SCHEDULE SID [PID]

Options:

  -a, --arg TEXT     Set spider cronjob argument NAME=VALUE (may be repeated)
  -e, --env TEXT     Set spider cronjob environment variable NAME=VALUE (may
                     be repeated)
  -t, --tag TEXT     Set spider cronjob tag (may have multiple)
  -d, --day INTEGER  Set spider cronjob data expiry days
  --help             Show this message and exit.

estela create job

Create a new job

SID is the spider's sid
PID is the project's pid (active project by default)

Usage:

estela create job [OPTIONS] SID [PID]

Options:

  -a, --arg TEXT     Set spider job argument NAME=VALUE (may be repeated)
  -e, --env TEXT     Set spider job environment variable NAME=VALUE (may be
                     repeated)
  -t, --tag TEXT     Set spider job tag (may have multiple)
  -d, --day INTEGER  Set spider job data expiry days
  --help             Show this message and exit.

estela create project

Create a new project

NAME is the project's name

Usage:

estela create project [OPTIONS] NAME

Options:

  --help  Show this message and exit.

estela data

Retrieve data from a given job and save it locally

Usage:

estela data [OPTIONS] COMMAND [ARGS]...

Options:

  --help  Show this message and exit.

Subcommands

job: Retrieve data from a job

estela data job

Retrieve data from a given job

SID is the spider's sid
PID is the project's pid (active project by default)
JID is the job's id
DATATYPE is the type of data to retrieve
FORMAT is the format to retrieve data

Usage:

estela data job [OPTIONS] JID SID [PID]

Options:

  -t, --datatype [items|requests|logs|stats]
  -f, --format [json|csv|tsv]
  --help                          Show this message and exit.

estela delete

Delete a resource

Usage:

estela delete [OPTIONS] COMMAND [ARGS]...

Options:

  --help  Show this message and exit.

Subcommands

project: Delete an existing project

estela delete project

Delete a project

PID is the project's pid

Usage:

estela delete project [OPTIONS] PID

Options:

  --help  Show this message and exit.

estela deploy

Deploy Scrapy project to estela API

Usage:

estela deploy [OPTIONS]

Options:

  -v, --verbose  Increase verbosity level (e.g., -v, -vv).
  --help         Show this message and exit.

estela init

Initialize estela project

PID is the project's pid

Usage:

estela init [OPTIONS] PID

Options:

  -p, --platform [scrapy|requests]
                                  Platform to use, it can be 'scrapy' or
                                  'requests'  [default: scrapy]
  -r, --requirements TEXT         Relative path to requirements inside your
                                  project  [default: requirements.txt]
  --help                          Show this message and exit.

estela list

Display the available resources

Usage:

estela list [OPTIONS] COMMAND [ARGS]...

Options:

  --help  Show this message and exit.

Subcommands

cronjob: List cronjobs of a given spider
job: List jobs of a given spider
project: List the current user's projects
spider: List a project's spiders

estela list cronjob

List cronjobs of a given spider

SID is the spider's sid
PID is the project's pid (active project by default)
TAG is the tag used to filter cronjobs

Usage:

estela list cronjob [OPTIONS] SID [PID]

Options:

  -t, --tag TEXT  Filter cronjobs by tag
  --help          Show this message and exit.

estela list job

List jobs of a given spider

SID is the spider's sid
PID is the project's pid (active project by default
TAG is the tag used to filter jobs

Usage:

estela list job [OPTIONS] SID [PID]

Options:

  -t, --tag TEXT  Filter jobs by tag
  --help          Show this message and exit.

estela list project

List the current user's projects

Usage:

estela list project [OPTIONS]

Options:

  --help  Show this message and exit.

estela list spider

List spiders of a given project

PID is the project's pid (active project by default)

Usage:

estela list spider [OPTIONS] [PID]

Options:

  --help  Show this message and exit.

Save your credentials

Usage:

estela login [OPTIONS]

Options:

  --username TEXT  Username for login. If username is not given, it will be
                   asked
  --password TEXT  Password for login. If password is not given, it will be
                   asked
  --host TEXT      API endpoint to send the requests. If host is not given, it
                   will be asked
  --help           Show this message and exit.

estela logout

Remove your credentials

Usage:

estela logout [OPTIONS]

Options:

  --help  Show this message and exit.

estela stop

Stop an active job or cronjob

Usage:

estela stop [OPTIONS] COMMAND [ARGS]...

Options:

  --help  Show this message and exit.

Subcommands

job: Stop an active job

estela stop job

Stop an active job

JID is the job's jid
SID is the spider's sid
PID is the project's pid (active project by default)

Usage:

estela stop job [OPTIONS] JID SID [PID]

Options:

  --help  Show this message and exit.

estela update

Update a resource

Usage:

estela update [OPTIONS] COMMAND [ARGS]...

Options:

  --help  Show this message and exit.

Subcommands

cronjob: Update a cronjob
job: Update a job

estela update cronjob

Update a cronjob

SID is the spider's sid
PID is the project's pid (active project by default)
CJID is the cronjob's cjid

Usage:

estela update cronjob [OPTIONS] CJID SID [PID]

Options:

  --status [ACTIVE|DISABLED]  Set cronjob status.
  -s, --schedule TEXT         Set cronjob crontab schedule.
  --persistent                Set job data as persistent.
  -d, --day INTEGER           Set spider cronjob data expiry days.
  --help                      Show this message and exit.

estela update job

Update a job

SID is the spider's sid
PID is the project's pid (active project by default)
JID is the job's jid

Usage:

estela update job [OPTIONS] JID SID [PID]

Options:

  --persistent       Set job data as persistent.
  -d, --day INTEGER  Set spider job data expiry days.
  --help             Show this message and exit.