My favorites | Sign in
Project Home Downloads Wiki Issues Source
Search
for
ConfigurationOptions  
Description of the configuration file and its options
Updated Oct 11, 2010 by tom.h.mi...@gmail.com

Your configuration/preferences file is searched for in the following order:

  • Current directory
  • $XDG_CONFIG_HOME/googlecl or $HOME/.config/googlecl if $XDG_CONFIG_HOME is undefined
  • $XDG_CONFIG_DIRS or /etc/xdg if $XDG_CONFIG_DIRS is undefined (with /googlecl appended to each directory)
  • ~/.googlecl (The configuration file home from v0.9.8 and earlier)
The file is assumed to be called "config." If no file is found, one is created. On POSIX systems, in the directory specified by the second item in the above list. On other systems, in ~/.googlecl as before. You can also specify a file with the --config option.

Windows users: Your configuration and data folder should be in the same folder as Documents, Photos, My Videos, etc. I believe it's typically C:\Users\USERNAME\.googlecl for Windows 7, and C:\Documents and Settings\USERNAME for XP.

Options

Each option description follows the format <name>: [<values>] description

All sections

Each of these values can be found in any section. The service being run will try to find the option in its own section, and failing that, in the GENERAL section.

  • <option>: [<string>] You can specify any option in the config file to use as a "general" case. When a command-line option is required (for example the username, or the title of an album created with Picasa), and nothing is passed in via the command line, this value will be used.
  • cap_results: [True, False] Cap the number of results to max_results. (That is, queries will only return one feed).
  • delete_prompt: [True, False] Prompt to confirm deletion of items.
  • force_gdata_v1: [True, False] Force GoogleCL to use the code written for version 1 of the gdata API. True will disable some functionality (e.g. being able to see/manipulate arbitrary uploads to Docs), but may be required if you are unable to copy and paste the verification code in the browser. (For advanced users: This forces the import_service() function in the google script to load the "service" module even when the "client" module is available.)
  • list_fields: [<field>,<field>,...] Comma-separated (no spaces) list of attributes to print out when using the 'list' task and no fields are specified on the command line. For a list of valid fields, see the README / manual.
  • max_results: [<integer>] Maximum number of results / entries to return. Sets the max-results query parameter of the uri. You can use this with cap_results to limit the amount of data being sent over the network.
  • regex: [True, False] Use regular expressions in matching titles.
  • tags_prompt: [True, False] Prompt for tags for each item being uploaded. (Not fully implemented).

Picasa

  • access: [public, private, protected] The default access level of the albums you create. Public means visible to all, private means unlisted, protected means sign-in required to view the album.

Docs

  • xxx_format: [<extension>] The extension to use for a type of document. The types of document are document, spreadsheet, and presentation. PDF files automatically use 'pdf' as the extension
  • xxx_editor: [<editor>] The editor to use for a type of document. The types of document are the same as the xxx_format option, plus pdf_editor in case you have a pdf editor.
  • decode_utf_8: [True,False] When you retrieve docs from the server, you can have GoogleCL try to remove the UTF-8 byte-order marker (BOM) from the document. Most users will not need to worry about this and want to leave this as undefined or false, but it's handy if you have an application sensitive to the BOM such as less or tex.
  • editor: [<editor>] The editor to use by default if the document type is not defined by an xxx_editor option. If this is not defined, will use the EDITOR environment variable instead.
  • format: [<extension>] The extension to use by default if the document type is not defined by an xxx_format option.

General

  • * auth_browser: [<browser>] Browser to launch when authenticating the OAuth request token. You should only need to authenticate to each service once.
  • * date_print_format: [<format string>] Format to use when printing date information. See the Python "time" documentation for formats (http://docs.python.org/library/time.html#time.strftime). For example: "%m %d at %H" for "<month> <day> at <hour>"
  • * delete_by_default: [True, False] When prompted to confirm deletion of an object, hitting enter directly will confirm the delete.
  • * missing_field_value: [<string>] Placeholder string to use when listing an invalid attribute, for example, the url of a contact.
  • * url_style: [site, direct] Which sub-style to use for listing urls. "Site" will typically put you at the website, while "direct" is usually a link directly to the resource.
Comment by sridharp...@gmail.com, Jun 22, 2010

Specified FF?, firefox? for the browser in the config file. I get the following error

Error using browser "FF?": 2? No such file or directory

Any help would be appreciated

Comment by dag...@gmail.com, Jun 22, 2010

proxy settings would be useful

Comment by brother....@gmail.com, Jun 22, 2010

i need proxy settings too

Comment by kr1...@gmail.com, Jun 22, 2010

It would be nice to support more than one user w/o having to modify .googlecl/config

Comment by Eric.Yar...@gmail.com, Jun 22, 2010

How can you set and get these variables from the CL?

Comment by devraj, Jun 22, 2010

For those looking for Proxy settings, trying following this document http://code.google.com/p/gdatacopier/wiki/ProxySupport

Comment by macdon...@gmail.com, Oct 8, 2010

I am a new mac user. Where is the configuration file stored? I've tried using terminal or Finder to find the config files, but no luck. Thanks!

Comment by macdon...@gmail.com, Oct 8, 2010

I found the answer. Load terminal, then: $ defaults write com.apple.finder AppleShowAllFiles? FALSE $ killall Finder

The .config directory will be visible in the home folder. Navigate to googlecl.

BTW -- I made an alias to this file and plopped it in a convenient place in my home directory, so I can change these options easily.

Comment by parkerbo...@gmail.com, Jun 30, 2011

This is not working for me on Win7 64-bit. C:\Users\myusername\.googlecl\config was created automatically. There is no other googlecl config file on my system. I am trying to add delete_prompt = False (or even delete_prompt: False) but no change occurs when I run googlecl.

Comment by caioigle...@gmail.com, Jun 30, 2011

Picasa commands ignore the config file. I cannot set delete_by_default to true or delete_prompt to false.

Comment by mana.co...@gmail.com, Jul 3, 2011

parkerbo...@gmail.com, I found a way:

- make sure you download the latest version from http://code.google.com/p/googlecl/downloads/list - the delete_prompt option has been replaced by the switch --yes

To delete all contacts (be patient though): >contacts delete --yes --title "."

Comment by nuncio.b...@gmail.com, Sep 7, 2011

Getting the following problem on Windows XP:

$ google docs list Please specify user: <specified my google user name> Traceback (most recent call last):

File "google", line 849, in <module> File "google", line 835, in main File "google", line 615, in run_once File "google", line 106, in authenticate File "googlecl\authentication.pyo", line 58, in check_access_token File "googlecl\docs\client.pyo", line 235, in is_token_valid File "googlecl\client.pyo", line 49, in is_token_valid File "googlecl\base.pyo", line 328, in is_token_valid File "atom\client.pyo", line 124, in get File "googlecl\client.pyo", line 60, in retry_request File "googlecl\base.pyo", line 387, in retry_operation
socket.gaierror: (11001, 'getaddrinfo failed')

Any idea?

Comment by JoshLoga...@gmail.com, Oct 7, 2011

I am trying to open docs in TextEdit? on a mac, and I am unsuccessful. TextEdit? tells me I do not have the proper permissions to open Test.txt. Any suggestions?


Sign in to add a comment
Powered by Google Project Hosting