Product documentation Docs
    • English
    • Deutsch
    • 日本語
    • 한국어
    • Français
  • More Sites
    • Now Community
    • Developer Site
    • Knowledge Base
    • Product Information
    • ServiceNow.com
    • Training
    • Customer Success Center
    • ServiceNow Support Videos
  • Log in

Product documentation

  • Home
How search works:
  • Punctuation and capital letters are ignored
  • Special characters like underscores (_) are removed
  • Known synonyms are applied
  • The most relevant topics (based on weighting and matching to search terms) are listed first in search results
Topics are ranked in search results by how closely they match your search terms
  • A match on the entire phrase you typed
  • A match on part of the phrase you typed
  • A match on ALL of the terms in the phrase you typed
  • A match on ANY of the terms in the phrase you typed

Note: Matches in titles are always highly ranked.

  • Release version
    Table of Contents
    • Now Platform capabilities
Table of Contents
Choose your release version
    Home Orlando Now Platform Capabilities Now Platform capabilities Agent Workspace Developing components for Workspace Set up your project

    Set up your project

    • Save as PDF Selected topic Topic & subtopics All topics in contents
    • Unsubscribe Log in to subscribe to topics and get notified when content changes.
    • Share this page

    Set up your project

    Create the component project and the set of files required to develop a component. You can connect to your instance and create an application scope for your component, or you can reserve a scope to verify later.

    Before you begin

    Set up your environment.

    Procedure

    1. If you are developing components in online mode, log into your instance. Otherwise, you can log in before deploying the component to your instance.
      1. Open your system's command line tool and execute this command.
        now-cli login

        Pass in values for these parameters.

        Name Description
        host Target ServiceNow instance. Only supports HTTPS protocol.
        method Authentication method to use.

        Default: basic.

        username User name to log in to the ServiceNow instance.
        password User password to log in to the ServiceNow instance.
        now-cli login --host http://myinstance.service-now.com --method basic --username username --password password
    2. Create a folder for your project and point your system's command line tool to the folder.
    3. Create the component project and all the files required to build a component.
      1. From the folder you created, execute this command.
        now-cli project

        Pass in values for these parameters.

        Name Description
        name Required. The project name. Must be a valid and unique npm package name.
        description The project description to be available in the npm registry and the plugins list in your instance.
        scope Suggested application scope to assign to this project and its components. If provided, the instance validates the name. Use the namespace identifier guidelines for application development on the instance. For more information, see Application scope.

        Maximum: 18 characters.

        Case: snake case.

        Default: x_customerprefix_componentname, where:
        • customerprefix is the value in the glide.appcreator.company.code system property on your instance.
        • componentname is the value provided in the component's name parameter when you created the project.

        Alternatively, you can add a value to the scopeName parameter in the now-ui.json file. For more information, see Change a component's application scope.

        offline When true, creates and scaffolds a component while disconnected from your instance. Skips validation of the given scope name.

        Default: false

        now-cli project --name @myorg/movie-quotes --description 'A web component that prints movie quotes.'
        now-cli project --name @myorg/hello-world --scope x_myorg_helloworld --offline
    4. Run the following command to install the npm dependencies.
      npm install

    What to do next

    Develop a component.
    Related concepts
    • Developing components for Workspace

    Tags:

    Feedback
    On this page

    Previous topic

    Next topic

    • Contact Us
    • Careers
    • Terms of Use
    • Privacy Statement
    • Sitemap
    • © ServiceNow. All rights reserved.

    Release version
    Choose your release version

      Set up your project

      • Save as PDF Selected topic Topic & subtopics All topics in contents
      • Unsubscribe Log in to subscribe to topics and get notified when content changes.
      • Share this page

      Set up your project

      Create the component project and the set of files required to develop a component. You can connect to your instance and create an application scope for your component, or you can reserve a scope to verify later.

      Before you begin

      Set up your environment.

      Procedure

      1. If you are developing components in online mode, log into your instance. Otherwise, you can log in before deploying the component to your instance.
        1. Open your system's command line tool and execute this command.
          now-cli login

          Pass in values for these parameters.

          Name Description
          host Target ServiceNow instance. Only supports HTTPS protocol.
          method Authentication method to use.

          Default: basic.

          username User name to log in to the ServiceNow instance.
          password User password to log in to the ServiceNow instance.
          now-cli login --host http://myinstance.service-now.com --method basic --username username --password password
      2. Create a folder for your project and point your system's command line tool to the folder.
      3. Create the component project and all the files required to build a component.
        1. From the folder you created, execute this command.
          now-cli project

          Pass in values for these parameters.

          Name Description
          name Required. The project name. Must be a valid and unique npm package name.
          description The project description to be available in the npm registry and the plugins list in your instance.
          scope Suggested application scope to assign to this project and its components. If provided, the instance validates the name. Use the namespace identifier guidelines for application development on the instance. For more information, see Application scope.

          Maximum: 18 characters.

          Case: snake case.

          Default: x_customerprefix_componentname, where:
          • customerprefix is the value in the glide.appcreator.company.code system property on your instance.
          • componentname is the value provided in the component's name parameter when you created the project.

          Alternatively, you can add a value to the scopeName parameter in the now-ui.json file. For more information, see Change a component's application scope.

          offline When true, creates and scaffolds a component while disconnected from your instance. Skips validation of the given scope name.

          Default: false

          now-cli project --name @myorg/movie-quotes --description 'A web component that prints movie quotes.'
          now-cli project --name @myorg/hello-world --scope x_myorg_helloworld --offline
      4. Run the following command to install the npm dependencies.
        npm install

      What to do next

      Develop a component.
      Related concepts
      • Developing components for Workspace

      Tags:

      Feedback

          Share this page

          Got it! Feel free to add a comment
          To share your product suggestions, visit the Idea Portal.
          Please let us know how to improve this content

          Check any that apply

          To share your product suggestions, visit the Idea Portal.
          Confirm

          We were unable to find "Coaching" in Jakarta. Would you like to search instead?

          No Yes
          • Contact Us
          • Careers
          • Terms of Use
          • Privacy Statement
          • Sitemap
          • © ServiceNow. All rights reserved.

          Subscribe Subscribed Unsubscribe Last updated: Tags: January February March April May June July August September October November December No Results Found Versions Search preferences successfully updated My release version successfully updated My release version successfully deleted An error has occurred. Please try again later. You have been unsubscribed from all topics. You are now subscribed to and will receive notifications if any changes are made to this page. You have been unsubscribed from this content Thank you for your feedback. Form temporarily unavailable. Please try again or contact  docfeedback@servicenow.com  to submit your comments. The topic you requested does not exist in the release. You were redirected to a related topic instead. The available release versions for this topic are listed There is no specific version for this documentation. Explore products Click to go to the page. Release notes and upgrades Click to open the dropdown menu. Delete Remove No selected version Reset This field is required You are already subscribed to this topic Attach screenshot The file you uploaded exceeds the allowed file size of 20MB. Please try again with a smaller file. Please complete the reCAPTCHA step to attach a screenshot
          Log in to personalize your search results and subscribe to topics
          No, thanks Login