Skip to content

Commit

Permalink
Merge pull request #121 from erinspace/feature/minor_docs_tweak
Browse files Browse the repository at this point in the history
change ls to list in getting started docs
  • Loading branch information
betatim committed Oct 13, 2017
2 parents feafef2 + a4061a3 commit e5ee584
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions docs/cli-usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,14 +16,14 @@ Below some examples on how to use the command-line program:
$ osf <command> -h

# list all files for a public project
$ osf -p <projectid> ls
$ osf -p <projectid> list

# setup a local folder for an existing project
$ osf init

# list all files for a private project
# set $OSF_PASSWORD to provide the password
$ osf -p <projectid> -u yourOSFacount@example.com ls
$ osf -p <projectid> -u yourOSFacount@example.com list

# fetch all files from a project and store them in `output_directory`
$ osf -p <projectid> clone [output_directory]
Expand All @@ -40,6 +40,8 @@ Below some examples on how to use the command-line program:
# remove a single file from an OSF project
$ osf -p <projectid> remove remote/file.txt

If you're using python 3+, you can also use the aliases `ls` in place of `list`, and `rm` in place of `remove`.


If the project is private you will need to provide authentication
details. You can provide your OSF account name as command-line argument
Expand All @@ -58,7 +60,7 @@ current directory. To set the username and project ID create
project = 9zpcy


after which you can simply run `osf ls` to list the contents of the project.
after which you can simply run `osf list` to list the contents of the project.


.. _OSF: https://osf.io

0 comments on commit e5ee584

Please sign in to comment.